You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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: "PlayerIdStringModel",
  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.

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>)


4514
4515
4516
4517
4518
4519
4520
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4514

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

#player_attributesHash<String,Types::AttributeValue>

Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. Example: "PlayerAttributes": \{"skill": \{"N": "23"\}, "gameMode": \{"S": "deathmatch"\}\}.

Returns:



4514
4515
4516
4517
4518
4519
4520
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4514

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

#player_idString

Unique identifier for a player

Returns:

  • (String)


4514
4515
4516
4517
4518
4519
4520
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4514

class Player < Struct.new(
  :player_id,
  :player_attributes,
  :team,
  :latency_in_ms)
  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)


4514
4515
4516
4517
4518
4519
4520
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4514

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