gpg:: TurnBasedMatch
#include <turn_based_match.h>
Structure de données contenant des données sur l'état actuel d'un TurnBasedMatch
.
Résumé
Constructeurs et destructeurs |
|
---|---|
TurnBasedMatch()
|
|
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
Crée une copie d'un élément
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 correspondance automatique disponibles pour la correspondance.
|
CreatingParticipant() const
|
Renvoie le participant qui a créé la correspondance.
|
CreationTime() const
|
std::chrono::milliseconds
Renvoie l'heure à laquelle cette valeur
TurnBasedMatch was created (exprimée en millisecondes depuis l'époque Unix). |
Data() const
|
const std::vector< uint8_t > &
Renvoie les données de correspondance, si
HasData() est vrai. |
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 tour précédent.
|
HasPreviousMatchData() const
|
bool
"True" s'il s'agit du premier tour d'une revanche et que les données de la précédente Valide doivent renvoyer la valeur "true" pour que cette fonction soit utilisable.
|
HasRematchId() const
|
bool
Renvoie "true" si cette correspondance a fait l'objet d'une nouvelle correspondance.
|
Id() const
|
const std::string &
Renvoie un ID qui identifie ce
TurnBasedMatch de manière unique. |
LastUpdateTime() const
|
Renvoie l'heure à laquelle cet élément
TurnBasedMatch a été mis à jour pour la dernière fois (exprimée en millisecondes depuis l'époque Unix). |
LastUpdatingParticipant() const
|
Affiche le participant qui a mis à jour la correspondance en dernier.
|
Number() const
|
uint32_t
Nombre indiquant le nombre de correspondances antérieures à celle-ci via des correspondances.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Renvoie les résultats de la correspondance.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Vecteur de tous les participants à cette partie.
|
PendingParticipant() const
|
Renvoie le participant qui a pour rôle de mettre à jour cette correspondance.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Les données de la correspondance précédente, si HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Renvoie l'identifiant de la correspondance qui est une revanche de cette correspondance, si disponible.
|
Status() const
|
Renvoie l'état de la correspondance du participant local.
|
SuggestedNextParticipant() const
|
Une fonction d'assistance qui sélectionne un participant valide parmi l'ensemble des participants joints, invitables et mis en correspondance automatiquement.
|
Valid() const
|
bool
Renvoie "true" si cet
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
Identifiant strictement incrémentiel, mis à jour à chaque modification d'une correspondance.
|
operator=(const TurnBasedMatch & copy_from)
|
Attribue ce
TurnBasedMatch en le copiant à partir d'un autre. |
operator=(TurnBasedMatch && move_from)
|
Attribue ce
TurnBasedMatch en y déplaçant une autre entité. |
Fonctions publiques
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Renvoie le nombre d'emplacements avec correspondance automatique disponibles pour la correspondance.
Ce nombre est égal au nombre d'emplacements de mise en 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.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Renvoie le participant qui a créé la correspondance.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
CreationTime
std::chrono::milliseconds CreationTime() const
Renvoie l'heure à laquelle cette valeur TurnBasedMatch was created
(exprimée en millisecondes depuis l'époque Unix).
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Données
const std::vector< uint8_t > & Data() const
Description
const std::string & Description() const
Renvoie un résumé généré par le serveur de l'état de la correspondance.
La valeur Valide 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 tour précédent.
La valeur Valide 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 que les données de la précédente Valide doivent renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasRematchId
bool HasRematchId() const
Renvoie "true" si cette correspondance a fait l'objet d'une nouvelle correspondance.
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. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
LastUpdateTime
Timestamp LastUpdateTime() const
Renvoie l'heure à laquelle cet élément TurnBasedMatch
a été mis à jour pour la dernière fois (exprimée en millisecondes depuis l'époque Unix).
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Affiche le participant qui a mis à jour la correspondance en dernier.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Nombre
uint32_t Number() const
Nombre indiquant le nombre de correspondances antérieures à celle-ci via des correspondances.
Défini sur 1 lors de la première correspondance, incrémenté d'une unité à chaque nouvelle partie.
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 ceux qui existent déjà. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Participants
const std::vector< MultiplayerParticipant > & Participants() const
Vecteur de tous les participants à cette partie.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Renvoie le participant qui a pour rôle de mettre à jour cette correspondance.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
Les données de la correspondance précédente, si HasPreviousMatchData().
Ne peut être appelé que si Valid renvoie la valeur "true".
RematchId
const std::string & RematchId() const
Renvoie l'identifiant de la correspondance qui est une revanche de cette correspondance, si disponible.
État
MatchStatus Status() const
Renvoie l'état de la correspondance du participant local.
L'état détermine les actions qui peuvent être effectuées sur la correspondance. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Une fonction d'assistance qui sélectionne un participant valide parmi l'ensemble des participants joints, invitables et mis en correspondance automatiquement.
Si cette fonction est systématiquement utilisée pour sélectionner le participant suivant, la lecture reprendra tous les participants dans l'ordre, en répétant si nécessaire. Cette fonction ne doit être appelée que si Status() est défini sur MatchStatus::MY_TURN, car c'est le seul moment où le résultat de cette fonction peut être utilisé de manière significative. Si elle est appelée de manière incorrecte, 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'un shared_ptr
vers un TurnBasedMatchImpl
.
Destiné à un usage interne par l'API.
TurnBasedMatch
TurnBasedMatch( const TurnBasedMatch & copy_from )
Crée une copie d'un élément TurnBasedMatch
existant.
TurnBasedMatch
TurnBasedMatch( TurnBasedMatch && move_from )
Déplace un élément TurnBasedMatch
existant.
Valide
bool Valid() const
Renvoie "true" si cet TurnBasedMatch
est renseigné avec des données.
Doit renvoyer "true" 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.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Version
uint32_t Version() const
Identifiant strictement incrémentiel, mis à jour à chaque modification d'une correspondance.
operator=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Attribue ce TurnBasedMatch
en le copiant à partir d'un autre.
operator=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Attribue ce TurnBasedMatch
en y déplaçant une autre entité.