Class: Aws::GameLift::Types::Player

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass Player data as a hash:

{
  player_id: "NonZeroAndMaxString",
  player_attributes: {
    "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  team: "NonZeroAndMaxString",
  latency_in_ms: {
    "NonEmptyString" => 1,
  },
}

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#latency_in_msHash<String,Integer>

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

Returns:

  • (Hash<String,Integer>)


6680
6681
6682
6683
6684
6685
6686
6687
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6680

class Player < Struct.new(
  :player_id,
  :player_attributes,
  :team,
  :latency_in_ms)
  SENSITIVE = []
  include Aws::Structure
end

#player_attributesHash<String,Types::AttributeValue>

A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": \{"skill": \{"N": "23"\}, "gameMode": \{"S": "deathmatch"\}\}.

Returns:



6680
6681
6682
6683
6684
6685
6686
6687
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6680

class Player < Struct.new(
  :player_id,
  :player_attributes,
  :team,
  :latency_in_ms)
  SENSITIVE = []
  include Aws::Structure
end

#player_idString

A unique identifier for a player

Returns:

  • (String)


6680
6681
6682
6683
6684
6685
6686
6687
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6680

class Player < Struct.new(
  :player_id,
  :player_attributes,
  :team,
  :latency_in_ms)
  SENSITIVE = []
  include Aws::Structure
end

#teamString

Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

Returns:

  • (String)


6680
6681
6682
6683
6684
6685
6686
6687
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6680

class Player < Struct.new(
  :player_id,
  :player_attributes,
  :team,
  :latency_in_ms)
  SENSITIVE = []
  include Aws::Structure
end