Skip to content

Player

Source code in docs_src/capo_gamelift/types/player.py
class Player(TypedDict, closed=True):
    player_id: NotRequired["capo_gamelift.types.player_id.PlayerId"]
    """<p>A unique identifier for a player</p>"""
    player_attributes: NotRequired[
        "capo_gamelift.types.player_attribute_map.PlayerAttributeMap"
    ]
    """<p>A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the <i>playerAttributes</i> used in a matchmaking rule set. Example: <code>"PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}</code>.</p> <p>You can provide up to 10 <code>PlayerAttributes</code>.</p>"""
    team: NotRequired["capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"]
    """<p>Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.</p>"""
    latency_in_ms: NotRequired["capo_gamelift.types.latency_map.LatencyMap"]
    """<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. </p> <p>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. </p>"""

latency_in_ms instance-attribute

latency_in_ms: NotRequired[LatencyMap]

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to a fleet location (Amazon Web Services Regions or custom locations for Amazon GameLift Servers Anywhere fleets). 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.

player_attributes instance-attribute

player_attributes: NotRequired[PlayerAttributeMap]

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.

player_id instance-attribute

player_id: NotRequired[PlayerId]

A unique identifier for a player

team instance-attribute

team: NotRequired[NonZeroAndMaxString]

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