gpg::ParticipantResults

#include <participant_results.h>

Une structure de données contenant des données sur les résultats par participant pour une TurnBasedMatch.

Résumé

Constructeurs et destructeurs

ParticipantResults()
ParticipantResults(std::shared_ptr< const ParticipantResultsImpl > impl)
Construit un objet ParticipantResults d'une shared_ptr à une ParticipantResultsImpl.
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 la valeur "true" si cet objet ParticipantResults a un résultat pour le MultiplayerParticipant donné.
MatchResultForParticipant(const std::string & participant_id) const
Renvoie le MatchResult pour le participant spécifié dans un TurnBasedMatch.
PlaceForParticipant(const std::string & participant_id) const
uint32_t
Renvoie le placement 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 ParticipantResults contenant tous les résultats existants et les données de résultats supplémentaires transmises à cette fonction.
operator=(const ParticipantResults & copy_from)
Attribue cet objet ParticipantResults à partir d'un autre objet.
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 la valeur "true" si cet objet ParticipantResults a un résultat pour le MultiplayerParticipant donné.

Valid 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 un TurnBasedMatch.

Notez que tous les participants ne peuvent pas avoir de MatchResult. Si HasResultsForParticipant ne renvoie pas la valeur "true", cette fonction renvoie la valeur MatchResult::NONE. Valid 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 d'une shared_ptr à une 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 placement du participant spécifié dans une TurnBasedMatch.

Notez que tous les participants ne peuvent pas obtenir de résultats. Si HasResultsForParticipant ne renvoie pas de valeur "true", cette fonction renvoie 0 pour un joueur qui n'est pas encore classé. Valid 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 ParticipantResults contenant tous les résultats existants et les données de résultats supplémentaires transmises à cette fonction.

Notez qu'un résultat ne peut être défini qu'une seule fois par participant. Si vous tentez de définir plusieurs résultats, une erreur sera consignée et la ParticipantResults ne sera pas modifiée. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

Détails
Paramètres
participant_id
MultiplayerParticipant pour lequel vous souhaitez ajouter un résultat.
placing
Classement du participant dans la partie.
result
La valeur MatchResult du participant dans la partie

opérateur=

ParticipantResults & operator=(
  const ParticipantResults & copy_from
)

Attribue cet objet ParticipantResults à partir d'un autre objet.

opérateur=

ParticipantResults & operator=(
  ParticipantResults && move_from
)

Attribue cet objet ParticipantResults en y déplaçant un autre objet.