Player
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.
Contents
Note
In the following list, the required parameters are described first.
- LatencyInMs
-
A set of values, expressed in milliseconds, that indicates 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.
To collect accurate latency data, use Amazon GameLift Servers's UDP ping beacons, which provide fixed endpoints in each Amazon GameLift Servers hosting location. These endpoints allow you to measure actual UDP network latency, which provides more accurate results than ICMP pings because UDP is the same protocol used by most game servers. For more information on using UDP ping beacons to measure latency, refer to UDP ping beacons in the Amazon GameLift Servers Developer Guide.
Type: String to integer map
Key Length Constraints: Minimum length of 1.
Valid Range: Minimum value of 1.
Required: No
- PlayerAttributes
-
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"}}.You can provide up to 10
PlayerAttributes.Type: String to AttributeValue object map
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- PlayerId
-
A unique identifier for a player
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- Team
-
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
