File Coverage

blib/lib/Paws/GameLift/Player.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::GameLift::Player;
2 1     1   580 use Moose;
  1         4  
  1         10  
3             has LatencyInMs => (is => 'ro', isa => 'Paws::GameLift::LatencyMap');
4             has PlayerAttributes => (is => 'ro', isa => 'Paws::GameLift::PlayerAttributeMap');
5             has PlayerId => (is => 'ro', isa => 'Str');
6             has Team => (is => 'ro', isa => 'Str');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::GameLift::Player
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::GameLift::Player object:
25              
26             $service_obj->Method(Att1 => { LatencyInMs => $value, ..., Team => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::Player object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->LatencyInMs
34              
35             =head1 DESCRIPTION
36              
37             Represents a player in matchmaking. When starting a matchmaking
38             request, a player has a player ID, attributes, and may have latency
39             data. Team information is added after a match has been successfully
40             completed.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 LatencyInMs => L<Paws::GameLift::LatencyMap>
46              
47             Set of values, expressed in milliseconds, indicating the amount of
48             latency that a player experiences when connected to AWS regions. If
49             this property is present, FlexMatch considers placing the match only in
50             regions for which latency is reported.
51              
52             If a matchmaker has a rule that evaluates player latency, players must
53             report latency in order to be matched. If no latency is reported in
54             this scenario, FlexMatch assumes that no regions are available to the
55             player and the ticket is not matchable.
56              
57              
58             =head2 PlayerAttributes => L<Paws::GameLift::PlayerAttributeMap>
59              
60             Collection of name:value pairs containing player information for use in
61             matchmaking. Player attribute names need to match I<playerAttributes>
62             names in the rule set being used. Example: C<"PlayerAttributes":
63             {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}>.
64              
65              
66             =head2 PlayerId => Str
67              
68             Unique identifier for a player
69              
70              
71             =head2 Team => Str
72              
73             Name of the team that the player is assigned to in a match. Team names
74             are defined in a matchmaking rule set.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89