gpg:: MultiplayerInvitation
#include <multiplayer_invitation.h>
A data structure containing data about the current state of an invitation to a turn-based match.
Summary
Constructors and Destructors |
|
---|---|
MultiplayerInvitation()
|
|
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
Creates a copy of an existing MultiplayerInvitation.
|
|
MultiplayerInvitation(MultiplayerInvitation && move_from)
Moves an existing MultiplayerInvitation into a new one.
|
Public functions |
|
---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
Returns the number of available auto-matching slots for the match for which this object is an invitation.
|
CreationTime() const
|
Returns the time at which the TurnBasedMatch for this invitation was created (expressed as milliseconds since the Unix epoch).
|
Id() const
|
const std::string &
Returns an ID that uniquely identifies this MultiplayerInvitation.
|
InvitingParticipant() const
|
Returns the participant who invited the local participant to the TurnBasedMatch for this invitation.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
A vector of all participants in the TurnBasedMatch for this invitation.
|
Type() const
|
Identifies whether this invitation is for a RealTimeRoom or a TurnBasedMatch.
|
Valid() const
|
bool
Returns true if this MultiplayerInvitation is populated with data.
|
Variant() const
|
uint32_t
Returns a game-specific variant identifier that a game can use to identify game mode.
|
operator=(const MultiplayerInvitation & copy_from)
|
Assigns this MultiplayerInvitation by copying from another one.
|
operator=(MultiplayerInvitation && move_from)
|
Assigns this MultiplayerInvitation by moving another one into it.
|
Public functions
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Returns the number of available auto-matching slots for the match for which this object is an invitation.
This value is equal to the number of auto-matching slots with which the match was created, minus the number of participants who have already been added via auto-matching. Valid must return true for this function to be usable.
CreationTime
Timestamp CreationTime() const
Returns the time at which the TurnBasedMatch for this invitation was created (expressed as milliseconds since the Unix epoch).
Valid must return true for this function to be usable.
Id
const std::string & Id() const
Returns an ID that uniquely identifies this MultiplayerInvitation.
Valid must return true for this function to be usable.
InvitingParticipant
MultiplayerParticipant InvitingParticipant() const
Returns the participant who invited the local participant to the TurnBasedMatch for this invitation.
Valid must return true for this function to be usable.
MultiplayerInvitation
MultiplayerInvitation()
MultiplayerInvitation
MultiplayerInvitation( std::shared_ptr< const TurnBasedMatchImpl > impl )
Constructs a MultiplayerInvitation from a shared_ptr
to a TurnBasedMatchImpl
.
Intended for internal use by the API.
MultiplayerInvitation
MultiplayerInvitation( std::shared_ptr< const RealTimeRoomImpl > impl )
Constructs a MultiplayerInvitation from a shared_ptr
to a RealTimeRoomImpl
.
Intended for internal use by the API.
MultiplayerInvitation
MultiplayerInvitation( const MultiplayerInvitation & copy_from )
Creates a copy of an existing MultiplayerInvitation.
MultiplayerInvitation
MultiplayerInvitation( MultiplayerInvitation && move_from )
Moves an existing MultiplayerInvitation into a new one.
Participants
const std::vector< MultiplayerParticipant > & Participants() const
A vector of all participants in the TurnBasedMatch for this invitation.
Valid must return true for this function to be usable.
Type
MultiplayerInvitationType Type() const
Identifies whether this invitation is for a RealTimeRoom or a TurnBasedMatch.
Valid
bool Valid() const
Returns true if this MultiplayerInvitation is populated with data.
Must be true in order for the getter functions (Id
, Variant
, etc.) on this MultiplayerInvitation object to be usable.
Variant
uint32_t Variant() const
Returns a game-specific variant identifier that a game can use to identify game mode.
Valid must return true for this function to be usable.
operator=
MultiplayerInvitation & operator=( const MultiplayerInvitation & copy_from )
Assigns this MultiplayerInvitation by copying from another one.
operator=
MultiplayerInvitation & operator=( MultiplayerInvitation && move_from )
Assigns this MultiplayerInvitation by moving another one into it.