gpg::TurnBasedMatch

#include <turn_based_match.h>

Structure de données contenant des données sur l'état actuel d'une TurnBasedMatch.

Résumé

Constructeurs et destructeurs

TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
Construit un TurnBasedMatch à partir d'une shared_ptr en TurnBasedMatchImpl.
TurnBasedMatch(const TurnBasedMatch & copy_from)
Crée une copie d'un TurnBasedMatch existant.
TurnBasedMatch(TurnBasedMatch && move_from)
Déplace un élément TurnBasedMatch existant.

Fonctions publiques

AutomatchingSlotsAvailable() const
uint32_t
Renvoie le nombre d'emplacements avec mise en correspondance automatique disponibles pour la correspondance.
CreatingParticipant() const
Renvoie le participant qui a créé cette correspondance.
CreationTime() const
std::chrono::milliseconds
Renvoie l'heure à laquelle cet événement TurnBasedMatch was created (exprimée en millisecondes depuis l'epoch Unix).
Data() const
const std::vector< uint8_t > &
Renvoie les données de correspondance si HasData() est "true".
Description() const
const std::string &
Renvoie un résumé généré par le serveur de l'état de la correspondance.
HasData() const
bool
"True" si cet objet comporte des données définies lors d'un virage précédent.
HasPreviousMatchData() const
bool
"True" s'il s'agit du premier tour d'une revanche, et les données de la précédente Valid doivent renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasRematchId() const
bool
Renvoie la valeur "true" si cette correspondance a été trouvée de nouveau.
Id() const
const std::string &
Renvoie un ID qui identifie ce TurnBasedMatch de manière unique.
LastUpdateTime() const
Renvoie l'heure à laquelle cette TurnBasedMatch a été mise à jour pour la dernière fois (exprimée en millisecondes depuis l'epoch Unix).
LastUpdatingParticipant() const
Renvoie le participant qui a mis à jour cette correspondance pour la dernière fois.
Number() const
uint32_t
Nombre indiquant le nombre de correspondances qui ont précédé celle-ci via une nouvelle mise en correspondance.
ParticipantResults() const
Renvoie les résultats de la correspondance.
Participants() const
const std::vector< MultiplayerParticipant > &
Vecteur de tous les participants à ce match.
PendingParticipant() const
Renvoie le participant qui est à son tour de mettre à jour cette partie.
PreviousMatchData() const
const std::vector< uint8_t > &
Données de la correspondance précédente, si HasPreviousMatchData().
RematchId() const
const std::string &
Renvoie l'ID de la correspondance, si disponible.
Status() const
Renvoie l'état de la correspondance pour le participant local.
SuggestedNextParticipant() const
Fonction d'assistance qui sélectionne un participant valide parmi l'ensemble des participants joints, invitables et associés automatiquement.
Valid() const
bool
Renvoie la valeur "true" si cet élément TurnBasedMatch est renseigné avec des données.
Variant() const
uint32_t
Renvoie un identifiant de variante spécifique au jeu qui peut être utilisé par un jeu pour identifier différents modes de jeu.
Version() const
uint32_t
ID strictement incrémenté, mis à jour chaque fois qu'une correspondance est modifiée.
operator=(const TurnBasedMatch & copy_from)
Attribue ce TurnBasedMatch en copiant un autre élément.
operator=(TurnBasedMatch && move_from)
Attribue cet élément TurnBasedMatch en y déplaçant un autre élément.

Fonctions publiques

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const 

Renvoie le nombre d'emplacements avec mise en correspondance automatique disponibles pour la correspondance.

Ce nombre est égal 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.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const 

Renvoie le participant qui a créé cette correspondance.

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

CreationTime

std::chrono::milliseconds CreationTime() const 

Renvoie l'heure à laquelle cet événement TurnBasedMatch was created (exprimée en millisecondes depuis l'epoch Unix).

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

Données

const std::vector< uint8_t > & Data() const 

Renvoie les données de correspondance si HasData() est "true".

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

Description

const std::string & Description() const 

Renvoie un résumé généré par le serveur de l'état de la correspondance.

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

HasData

bool HasData() const 

"True" si cet objet comporte des données définies lors d'un virage précédent.

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

HasPreviousMatchData

bool HasPreviousMatchData() const 

"True" s'il s'agit du premier tour d'une revanche, et les données de la précédente Valid doivent renvoyer la valeur "true" pour que cette fonction soit utilisable.

HasRematchId

bool HasRematchId() const 

Renvoie la valeur "true" si cette correspondance a été trouvée de nouveau.

ID

const std::string & Id() const 

Renvoie un ID qui identifie ce TurnBasedMatch de manière unique.

Utilisez cette option avec TurnBasedMultiplayerManager::FetchMatch pour récupérer cette correspondance ultérieurement. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

LastUpdateTime

Timestamp LastUpdateTime() const 

Renvoie l'heure à laquelle cette TurnBasedMatch a été mise à jour pour la dernière fois (exprimée en millisecondes depuis l'epoch Unix).

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

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const 

Renvoie le participant qui a mis à jour cette correspondance pour la dernière fois.

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

Nombre

uint32_t Number() const 

Nombre indiquant le nombre de correspondances qui ont précédé celle-ci via une nouvelle mise en correspondance.

Elle est définie sur 1 lors de la première partie et incrémentée de 1 à chaque revanche.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const 

Renvoie les résultats de la correspondance.

Les résultats peuvent être définis via TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn et d'autres fonctions associées. Utilisez toujours ParticipantResults().WithResult(...) pour créer un objet ParticipantResults cohérent avec tous les objets existants. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

Participants

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

Vecteur de tous les participants à ce match.

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

PendingParticipant

MultiplayerParticipant PendingParticipant() const 

Renvoie le participant qui est à son tour de mettre à jour cette partie.

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

PreviousMatchData

const std::vector< uint8_t > & PreviousMatchData() const 

Données de la correspondance précédente, si HasPreviousMatchData().

Ne peut être appelé que si Valide renvoie la valeur "true".

RematchId

const std::string & RematchId() const 

Renvoie l'ID de la correspondance, si disponible.

État

MatchStatus Status() const 

Renvoie l'état de la correspondance pour le participant local.

L'état détermine les actions qui peuvent être effectuées sur la correspondance. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const 

Fonction d'assistance qui sélectionne un participant valide parmi l'ensemble des participants joints, invitables et associés automatiquement.

Si cette fonction est toujours utilisée pour sélectionner le participant suivant, la lecture suivra tous les participants dans l'ordre, en répétant si nécessaire. Cette fonction ne doit être appelée que si Status() a la valeur MatchStatus::MY_TURN, car c'est le seul moment où le résultat de cette fonction peut être utilisé de manière significative. En cas d'appel incorrect, cette fonction renvoie un participant non valide (MultiplayerParticipant::Valid() == false).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Construit un TurnBasedMatch à partir d'une shared_ptr en TurnBasedMatchImpl.

Destiné à un usage interne par l'API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Crée une copie d'un TurnBasedMatch existant.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Déplace un élément TurnBasedMatch existant.

Valide

bool Valid() const 

Renvoie la valeur "true" si cet élément TurnBasedMatch est renseigné avec des données.

La valeur "true" doit être renvoyée pour que les fonctions getter de l'objet TurnBasedMatch (Id, CreationTime, etc.) soient utilisables.

Variant

uint32_t Variant() const 

Renvoie un identifiant de variante spécifique au jeu qui peut être utilisé par un jeu pour identifier différents modes de jeu.

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

Version

uint32_t Version() const 

ID strictement incrémenté, mis à jour chaque fois qu'une correspondance est modifiée.

opérateur=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Attribue ce TurnBasedMatch en copiant un autre élément.

opérateur=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Attribue cet élément TurnBasedMatch en y déplaçant un autre élément.