Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.Types.Player

Description

Synopsis

data Player = Player' {
- playerAttributes :: Maybe (HashMap Text AttributeValue)
- team :: Maybe Text
- playerId :: Maybe Text
- latencyInMs :: Maybe (HashMap Text Natural)
}
newPlayer :: Player
player_playerAttributes :: Lens' Player (Maybe (HashMap Text AttributeValue))
player_team :: Lens' Player (Maybe Text)
player_playerId :: Lens' Player (Maybe Text)
player_latencyInMs :: Lens' Player (Maybe (HashMap Text Natural))

Documentation

data Player Source #

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: newPlayer smart constructor.

Constructors

Player'

Fields

playerAttributes :: Maybe (HashMap Text 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"}}.
team :: Maybe Text
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
playerId :: Maybe Text
A unique identifier for a player
latencyInMs :: Maybe (HashMap Text Natural)
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.

Instances

Instances details

Eq Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods (==) :: Player -> Player -> Bool # (/=) :: Player -> Player -> Bool #
Read Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods readsPrec :: Int -> ReadS Player # readList :: ReadS [Player] # readPrec :: ReadPrec Player # readListPrec :: ReadPrec [Player] #
Show Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods showsPrec :: Int -> Player -> ShowS # show :: Player -> String # showList :: [Player] -> ShowS #
Generic Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Associated Types type Rep Player :: Type -> Type # Methods from :: Player -> Rep Player x # to :: Rep Player x -> Player #
NFData Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods rnf :: Player -> () #
Hashable Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods hashWithSalt :: Int -> Player -> Int # hash :: Player -> Int #
ToJSON Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods toJSON :: Player -> Value # toEncoding :: Player -> Encoding # toJSONList :: [Player] -> Value # toEncodingList :: [Player] -> Encoding #
FromJSON Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player Methods parseJSON :: Value -> Parser Player # parseJSONList :: Value -> Parser [Player] #
type Rep Player Source #
Instance details Defined in Amazonka.GameLift.Types.Player type Rep Player = D1 ('MetaData "Player" "Amazonka.GameLift.Types.Player" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "Player'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "playerAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AttributeValue))) :: S1 ('MetaSel ('Just "team") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latencyInMs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Natural))))))

newPlayer :: Player Source #

Create a value of Player with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:playerAttributes:Player', player_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"}}.

$sel:team:Player', player_team - Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

$sel:playerId:Player', player_playerId - A unique identifier for a player

$sel:latencyInMs:Player', player_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.

player_playerAttributes :: Lens' Player (Maybe (HashMap Text AttributeValue)) Source #

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"}}.

player_team :: Lens' Player (Maybe Text) Source #

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

player_playerId :: Lens' Player (Maybe Text) Source #

A unique identifier for a player

player_latencyInMs :: Lens' Player (Maybe (HashMap Text Natural)) Source #

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.