Package software.amazon.awssdk.services.gamelift.model

Interface Player.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Player.Builder,Player>, SdkBuilder<Player.Builder,Player>, SdkPojo
Enclosing class:
Player
public static interface Player.Builder extends SdkPojo, CopyableBuilder<Player.Builder,Player>

  • Method Details

    • playerId

      Player.Builder playerId(String playerId)

      A unique identifier for a player

      Parameters:
      playerId - A unique identifier for a player
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playerAttributes

      Player.Builder playerAttributes(Map<String,AttributeValue> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • team

      Player.Builder team(String team)

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

      Parameters:
      team - Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latencyInMs

      Player.Builder latencyInMs(Map<String,Integer> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.