gpg:: TurnBasedMatchConfig
#include <turn_based_match_config.h>
A data structure containing the data needed to create a TurnBasedMatch
.
Summary
Constructors and Destructors |
|
---|---|
TurnBasedMatchConfig(std::shared_ptr< const TurnBasedMatchConfigImpl > impl)
|
|
TurnBasedMatchConfig()
|
|
TurnBasedMatchConfig(const TurnBasedMatchConfig & copy_from)
Creates a copy of an existing
TurnBasedMatchConfig . |
|
TurnBasedMatchConfig(TurnBasedMatchConfig && move_from)
Moves an existing
TurnBasedMatchConfig . |
Public functions |
|
---|---|
ExclusiveBitMask() const
|
int64_t
A bit mask indicating game-specific exclusive roles for the player, such as "attacker" or "defender".
|
MaximumAutomatchingPlayers() const
|
uint32_t
The maximum number of auto-matching players to add to the match.
|
MinimumAutomatchingPlayers() const
|
uint32_t
The minimum number of auto-matching players to add to the match.
|
PlayerIdsToInvite() const
|
const std::vector< std::string > &
The player IDs to invite to the newly created match.
|
Valid() const
|
bool
Returns true if this
TurnBasedMatchConfig is populated with data. |
Variant() const
|
uint32_t
A developer-specific value used to indicate match type or mode.
|
operator=(const TurnBasedMatchConfig & copy_from)
|
Assigns this
TurnBasedMatchConfig by copying from another one. |
operator=(TurnBasedMatchConfig && move_from)
|
Assigns this
TurnBasedMatchConfig by moving another one into it. |
Classes |
|
---|---|
gpg:: |
Builds one or more TurnBasedMatchConfig objects. |
Public functions
ExclusiveBitMask
int64_t ExclusiveBitMask() const
A bit mask indicating game-specific exclusive roles for the player, such as "attacker" or "defender".
The logical product (AND) of any pairing players must equal zero for auto-match. Can only be called if Valid returns true.
MaximumAutomatchingPlayers
uint32_t MaximumAutomatchingPlayers() const
The maximum number of auto-matching players to add to the match.
Can only be called if Valid returns true.
MinimumAutomatchingPlayers
uint32_t MinimumAutomatchingPlayers() const
The minimum number of auto-matching players to add to the match.
Can only be called if Valid returns true.
PlayerIdsToInvite
const std::vector< std::string > & PlayerIdsToInvite() const
The player IDs to invite to the newly created match.
Can only be called if Valid returns true.
TurnBasedMatchConfig
TurnBasedMatchConfig( std::shared_ptr< const TurnBasedMatchConfigImpl > impl )
Constructs a TurnBasedMatchConfig
from a shared_ptr
to a TurnBasedMatchConfigImpl
.
Intended for internal use by the API.
TurnBasedMatchConfig
TurnBasedMatchConfig()
TurnBasedMatchConfig
TurnBasedMatchConfig( const TurnBasedMatchConfig & copy_from )
Creates a copy of an existing TurnBasedMatchConfig
.
TurnBasedMatchConfig
TurnBasedMatchConfig( TurnBasedMatchConfig && move_from )
Moves an existing TurnBasedMatchConfig
.
Valid
bool Valid() const
Returns true if this TurnBasedMatchConfig
is populated with data.
Must return true for the getter functions (PlayerIdsToInvite
, MinimumAutomatchingPlayers
, etc.) on the TurnBasedMatchConfig
object to be usable.
Variant
uint32_t Variant() const
A developer-specific value used to indicate match type or mode.
Only players using the same value can match. Can only be called if Valid returns true.
operator=
TurnBasedMatchConfig & operator=( const TurnBasedMatchConfig & copy_from )
Assigns this TurnBasedMatchConfig
by copying from another one.
operator=
TurnBasedMatchConfig & operator=( TurnBasedMatchConfig && move_from )
Assigns this TurnBasedMatchConfig
by moving another one into it.