gpg:: MultiplayerInvitation
#include <multiplayer_invitation.h>
Structure de données contenant des données sur l'état actuel d'une invitation à une partie au tour par tour.
Résumé
Constructeurs et destructeurs |
|
---|---|
MultiplayerInvitation()
|
|
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
Crée une copie d'une classe MultiplayerInvitation existante.
|
|
MultiplayerInvitation(MultiplayerInvitation && move_from)
Déplace une classe MultiplayerInvitation existante dans une nouvelle.
|
Fonctions publiques |
|
---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
Renvoie le nombre d'emplacements avec correspondance automatique disponibles pour la correspondance pour laquelle cet objet est une invitation.
|
CreationTime() const
|
Renvoie l'heure à laquelle la valeur TurnBasedMatch pour cette invitation a été créée (exprimée en millisecondes depuis l'époque Unix).
|
Id() const
|
const std::string &
Renvoie un ID qui identifie de manière unique la classe MultiplayerInvitation.
|
InvitingParticipant() const
|
Renvoie le participant qui a invité le participant local à participer à la TurnBasedMatch pour cette invitation.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Vecteur de tous les participants au TurnBasedMatch pour cette invitation.
|
Type() const
|
Indique si cette invitation concerne une RealTimeRoom ou une TurnBasedMatch.
|
Valid() const
|
bool
Renvoie la valeur "true" si la classe MultiplayerInvitation est remplie de données.
|
Variant() const
|
uint32_t
Renvoie un identifiant de variante spécifique au jeu, qu'il peut utiliser pour identifier le mode de jeu.
|
operator=(const MultiplayerInvitation & copy_from)
|
Attribue la classe MultiplayerInvitation en la copiant à partir d'une autre invitation.
|
operator=(MultiplayerInvitation && move_from)
|
Attribue la classe MultiplayerInvitation en y déplaçant une autre invitation.
|
Fonctions publiques
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Renvoie le nombre d'emplacements avec correspondance automatique disponibles pour la correspondance pour laquelle cet objet est une invitation.
Cette valeur est égale au nombre d'emplacements avec correspondance automatique avec lesquels la mise en correspondance a été créée, moins le nombre de participants qui ont déjà été ajoutés via cette fonctionnalité. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
CreationTime
Timestamp CreationTime() const
Renvoie l'heure à laquelle la valeur TurnBasedMatch pour cette invitation a été créée (exprimée en millisecondes depuis l'époque Unix).
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
ID
const std::string & Id() const
Renvoie un ID qui identifie de manière unique la classe MultiplayerInvitation.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
InvitingParticipant
MultiplayerParticipant InvitingParticipant() const
Renvoie le participant qui a invité le participant local à participer à la TurnBasedMatch pour cette invitation.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
MultiplayerInvitation
MultiplayerInvitation()
MultiplayerInvitation
MultiplayerInvitation( std::shared_ptr< const TurnBasedMatchImpl > impl )
Construit un MultiplayerInvitation à partir d'un shared_ptr
vers un TurnBasedMatchImpl
.
Destiné à un usage interne par l'API.
MultiplayerInvitation
MultiplayerInvitation( std::shared_ptr< const RealTimeRoomImpl > impl )
Construit un MultiplayerInvitation à partir d'un shared_ptr
vers un RealTimeRoomImpl
.
Destiné à un usage interne par l'API.
MultiplayerInvitation
MultiplayerInvitation( const MultiplayerInvitation & copy_from )
Crée une copie d'une classe MultiplayerInvitation existante.
MultiplayerInvitation
MultiplayerInvitation( MultiplayerInvitation && move_from )
Déplace une classe MultiplayerInvitation existante dans une nouvelle.
Participants
const std::vector< MultiplayerParticipant > & Participants() const
Vecteur de tous les participants au TurnBasedMatch pour cette invitation.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Type
MultiplayerInvitationType Type() const
Indique si cette invitation concerne une RealTimeRoom ou une TurnBasedMatch.
Valide
bool Valid() const
Renvoie la valeur "true" si la classe MultiplayerInvitation est remplie de données.
Doit être "true" pour que les fonctions getter (Id
, Variant
, etc.) de cet objet MultiplayerInvitation soient utilisables.
Variant
uint32_t Variant() const
Renvoie un identifiant de variante spécifique au jeu, qu'il peut utiliser pour identifier le mode de jeu.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
operator=
MultiplayerInvitation & operator=( const MultiplayerInvitation & copy_from )
Attribue la classe MultiplayerInvitation en la copiant à partir d'une autre invitation.
operator=
MultiplayerInvitation & operator=( MultiplayerInvitation && move_from )
Attribue la classe MultiplayerInvitation en y déplaçant une autre invitation.