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)
Construit une MultiplayerInvitation d'une shared_ptr à une TurnBasedMatchImpl.
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
Construit une MultiplayerInvitation d'une shared_ptr à une RealTimeRoomImpl.
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
Crée une copie d'un MultiplayerInvitation existant.
MultiplayerInvitation(MultiplayerInvitation && move_from)
Déplace une classe MultiplayerInvitation existante vers une nouvelle.

Fonctions publiques
AutomatchingSlotsAvailable() const
uint32_t
Renvoie le nombre d'emplacements mis en correspondance automatiquement disponibles pour la correspondance pour laquelle cet objet est une invitation.
CreationTime() const
Renvoie l'heure à laquelle TurnBasedMatch pour cette invitation a été créée (en millisecondes depuis l'epoch Unix).
Id() const
const std::string &
Renvoie un ID qui identifie la classe MultiplayerInvitation de manière unique.
InvitingParticipant() const
Renvoie le participant qui a invité le participant local à la session TurnBasedMatch de cette invitation.
Participants() const
const std::vector< MultiplayerParticipant > &
Vecteur de tous les participants à la phase TurnBasedMatch de cette invitation.
Type() const
Indique si cette invitation est pour une salle RealTimeRoom ou TurnBasedMatch.
Valid() const
bool
Renvoie la valeur "true" si la classe MultiplayerInvitation est renseignée avec des données.
Variant() const
uint32_t
Renvoie un identifiant de variante spécifique au jeu qu'un jeu peut utiliser pour identifier le mode de jeu.
operator=(const MultiplayerInvitation & copy_from)
Attribue cette MultiplayerInvitation en la copiant à partir d'une autre.
operator=(MultiplayerInvitation && move_from)
Attribue cette classe MultiplayerInvitation en y déplaçant une autre.

Fonctions publiques

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

Renvoie le nombre d'emplacements mis en correspondance automatiquement disponibles pour la correspondance pour laquelle cet objet est une invitation.

Cette valeur est égale au nombre d'emplacements de mise en correspondance automatique avec lesquels la correspondance a été créée, moins le nombre de participants qui ont déjà été ajoutés via la mise en correspondance automatique. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

CreationTime

Timestamp CreationTime() const

Renvoie l'heure à laquelle TurnBasedMatch pour cette invitation a été créée (en millisecondes depuis l'epoch Unix).

Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

ID

const std::string & Id() const

Renvoie un ID qui identifie la classe MultiplayerInvitation de manière unique.

Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

InvitingParticipant

MultiplayerParticipant InvitingParticipant() const

Renvoie le participant qui a invité le participant local à la session TurnBasedMatch de cette invitation.

Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

MultiplayerInvitation

 MultiplayerInvitation()

MultiplayerInvitation

 MultiplayerInvitation(
  std::shared_ptr< const TurnBasedMatchImpl > impl
)

Construit une MultiplayerInvitation d'une shared_ptr à une TurnBasedMatchImpl.

Destiné à un usage interne par l'API.

MultiplayerInvitation

 MultiplayerInvitation(
  std::shared_ptr< const RealTimeRoomImpl > impl
)

Construit une MultiplayerInvitation d'une shared_ptr à une RealTimeRoomImpl.

Destiné à un usage interne par l'API.

MultiplayerInvitation

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

Crée une copie d'un MultiplayerInvitation existant.

MultiplayerInvitation

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

Déplace une classe MultiplayerInvitation existante vers une nouvelle.

Participants

const std::vector< MultiplayerParticipant > & Participants() const

Vecteur de tous les participants à la phase TurnBasedMatch de cette invitation.

Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

Type

MultiplayerInvitationType Type() const

Indique si cette invitation est pour une salle RealTimeRoom ou TurnBasedMatch.

Valide

bool Valid() const

Renvoie la valeur "true" si la classe MultiplayerInvitation est renseignée avec des données.

La valeur 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'un jeu peut utiliser pour identifier le mode de jeu.

Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

opérateur=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

Attribue cette MultiplayerInvitation en la copiant à partir d'une autre.

opérateur=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

Attribue cette classe MultiplayerInvitation en y déplaçant une autre.