Struct aws_sdk_gamelift::types::builders::PlayerBuilder

#[non_exhaustive]
pub struct PlayerBuilder { /* private fields */ }

A builder for Player.

Implementations

impl PlayerBuilder

pub fn player_id(self, input: impl Into<String>) -> Self

A unique identifier for a player

pub fn set_player_id(self, input: Option<String>) -> Self

A unique identifier for a player

pub fn get_player_id(&self) -> &Option<String>

A unique identifier for a player

pub fn player_attributes(self, k: impl Into<String>, v: AttributeValue) -> Self

Adds a key-value pair to player_attributes.

To override the contents of this collection use set_player_attributes.

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.

pub fn set_player_attributes( self, input: Option<HashMap<String, AttributeValue>> ) -> Self

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.

pub fn get_player_attributes(&self) -> &Option<HashMap<String, 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"}}.

You can provide up to 10 PlayerAttributes.

pub fn team(self, input: impl Into<String>) -> Self

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

pub fn set_team(self, input: Option<String>) -> Self

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

pub fn get_team(&self) -> &Option<String>

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

pub fn latency_in_ms(self, k: impl Into<String>, v: i32) -> Self

Adds a key-value pair to latency_in_ms.

To override the contents of this collection use set_latency_in_ms.

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.

pub fn set_latency_in_ms(self, input: Option<HashMap<String, i32>>) -> Self

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.

pub fn get_latency_in_ms(&self) -> &Option<HashMap<String, i32>>

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.

pub fn build(self) -> Player

Consumes the builder and constructs a Player.

Trait Implementations

impl Clone for PlayerBuilder

fn clone(&self) -> PlayerBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlayerBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PlayerBuilder

fn default() -> PlayerBuilder

Returns the “default value” for a type.

impl PartialEq for PlayerBuilder

fn eq(&self, other: &PlayerBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlayerBuilder