File Coverage

blib/lib/Paws/GameLift/MatchmakingRuleSet.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::MatchmakingRuleSet;
2 1     1   282 use Moose;
  1         3  
  1         6  
3             has CreationTime => (is => 'ro', isa => 'Str');
4             has RuleSetBody => (is => 'ro', isa => 'Str', required => 1);
5             has RuleSetName => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::GameLift::MatchmakingRuleSet
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::GameLift::MatchmakingRuleSet object:
24              
25             $service_obj->Method(Att1 => { CreationTime => $value, ..., RuleSetName => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::MatchmakingRuleSet object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->CreationTime
33              
34             =head1 DESCRIPTION
35              
36             Set of rule statements, used with FlexMatch, that determine how to
37             build a certain kind of player match. Each rule set describes a type of
38             group to be created and defines the parameters for acceptable player
39             matches. Rule sets are used in MatchmakingConfiguration objects.
40              
41             A rule set may define the following elements for a match. For detailed
42             information and examples showing how to construct a rule set, see
43             Create Matchmaking Rules for Your Game.
44              
45             =over
46              
47             =item *
48              
49             Teams -- Required. A rule set must define one or multiple teams for the
50             match and set minimum and maximum team sizes. For example, a rule set
51             might describe a 4x4 match that requires all eight slots to be filled.
52              
53             =item *
54              
55             Player attributes -- Optional. These attributes specify a set of player
56             characteristics to evaluate when looking for a match. Matchmaking
57             requests that use a rule set with player attributes must provide the
58             corresponding attribute values. For example, an attribute might specify
59             a player's skill or level.
60              
61             =item *
62              
63             Rules -- Optional. Rules define how to evaluate potential players for a
64             match based on player attributes. A rule might specify minimum
65             requirements for individual players--such as each player must meet a
66             certain skill level, or may describe an entire group--such as all teams
67             must be evenly matched or have at least one player in a certain role.
68              
69             =item *
70              
71             Expansions -- Optional. Expansions allow you to relax the rules after a
72             period of time if no acceptable matches are found. This feature lets
73             you balance getting players into games in a reasonable amount of time
74             instead of making them wait indefinitely for the best possible match.
75             For example, you might use an expansion to increase the maximum skill
76             variance between players after 30 seconds.
77              
78             =back
79              
80              
81             =head1 ATTRIBUTES
82              
83              
84             =head2 CreationTime => Str
85              
86             Time stamp indicating when this data object was created. Format is a
87             number expressed in Unix time as milliseconds (for example
88             "1469498468.057").
89              
90              
91             =head2 B<REQUIRED> RuleSetBody => Str
92              
93             Collection of matchmaking rules, formatted as a JSON string. (Note that
94             comments14 are not allowed in JSON, but most elements support a
95             description field.)
96              
97              
98             =head2 RuleSetName => Str
99              
100             Unique identifier for a matchmaking rule set
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115