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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Player as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#latency_in_ms ⇒ Hash<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>) —

    Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions.

#player_attributes ⇒ Hash<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:

  • (Hash<String,Types::AttributeValue>) —

    A collection of key:value pairs containing player information for use in matchmaking.

#player_id ⇒ String

A unique identifier for a player

Returns:

  • (String) —

    A unique identifier for a player.

#team ⇒ String

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

Returns:

  • (String) —

    Name of the team that the player is assigned to in a match.