gpg:: ParticipantResults
#include <participant_results.h>
Structure de données contenant des données sur les résultats par participant pour un TurnBasedMatch
.
Résumé
Constructeurs et destructeurs |
|
---|---|
ParticipantResults()
|
|
ParticipantResults(std::shared_ptr< const ParticipantResultsImpl > impl)
|
|
ParticipantResults(const ParticipantResults & copy_from)
Crée une copie d'un objet
ParticipantResults existant. |
|
ParticipantResults(ParticipantResults && move_from)
Déplace un objet
ParticipantResults existant. |
Fonctions publiques |
|
---|---|
HasResultsForParticipant(const std::string & participant_id) const
|
bool
Renvoie "true" si cet objet
ParticipantResults présente un résultat pour la MultiplayerParticipant donnée. |
MatchResultForParticipant(const std::string & participant_id) const
|
Renvoie le
MatchResult pour le participant spécifié dans une TurnBasedMatch . |
PlaceForParticipant(const std::string & participant_id) const
|
uint32_t
Renvoie le positionnement du participant spécifié dans une
TurnBasedMatch . |
Valid() const
|
bool
Renvoie la valeur "true" si cet objet
ParticipantResults est renseigné avec des données. |
WithResult(const std::string & participant_id, uint32_t placing, MatchResult result) const
|
Crée un objet
ParticipantResults contenant tous les résultats existants et les données de résultat supplémentaires transmises à cette fonction. |
operator=(const ParticipantResults & copy_from)
|
Attribue cet objet
ParticipantResults à partir d'un autre. |
operator=(ParticipantResults && move_from)
|
Attribue cet objet
ParticipantResults en y déplaçant un autre objet. |
Fonctions publiques
HasResultsForParticipant
bool HasResultsForParticipant( const std::string & participant_id ) const
Renvoie "true" si cet objet ParticipantResults
présente un résultat pour la MultiplayerParticipant
donnée.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
MatchResultForParticipant
MatchResult MatchResultForParticipant( const std::string & participant_id ) const
Renvoie le MatchResult
pour le participant spécifié dans une TurnBasedMatch
.
Notez qu'il est possible que les participants n'aient pas tous un MatchResult. Si HasResultsForParticipant ne renvoie pas "true", cette fonction renvoie MatchResult::NONE
. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
ParticipantResults
ParticipantResults()
ParticipantResults
ParticipantResults( std::shared_ptr< const ParticipantResultsImpl > impl )
Construit un objet ParticipantResults
à partir d'un shared_ptr
vers un ParticipantResultsImpl
.
Destiné à un usage interne par l'API.
ParticipantResults
ParticipantResults( const ParticipantResults & copy_from )
Crée une copie d'un objet ParticipantResults
existant.
ParticipantResults
ParticipantResults( ParticipantResults && move_from )
Déplace un objet ParticipantResults
existant.
PlaceForParticipant
uint32_t PlaceForParticipant( const std::string & participant_id ) const
Renvoie le positionnement du participant spécifié dans une TurnBasedMatch
.
Notez que tous les participants ne peuvent pas avoir de résultats. Si HasResultsForParticipant ne renvoie pas la valeur "true", cette fonction renvoie 0 pour un joueur qui n'est pas encore classé. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Valide
bool Valid() const
Renvoie la valeur "true" si cet objet ParticipantResults
est renseigné avec des données.
Doit être "true" pour que les fonctions getter (PlaceForParticipant
, MatchResultForParticipant
, etc.) de cet objet ParticipantResults
soient utilisables.
WithResult
ParticipantResults WithResult( const std::string & participant_id, uint32_t placing, MatchResult result ) const
Crée un objet ParticipantResults
contenant tous les résultats existants et les données de résultat supplémentaires transmises à cette fonction.
Notez qu'un résultat ne peut être défini qu'une seule fois par participant. Si vous essayez de définir plusieurs résultats, une erreur sera consignée et la propriété ParticipantResults
ne sera pas modifiée. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
operator=
ParticipantResults & operator=( const ParticipantResults & copy_from )
Attribue cet objet ParticipantResults
à partir d'un autre.
operator=
ParticipantResults & operator=( ParticipantResults && move_from )
Attribue cet objet ParticipantResults
en y déplaçant un autre objet.