gpg::ParticipantResults

#include <participant_results.h>

Eine Datenstruktur mit Daten zu den Ergebnissen pro Teilnehmer für eine TurnBasedMatch.

Zusammenfassung

Konstruktoren und Zerstörer
ParticipantResults()
ParticipantResults(std::shared_ptr< const ParticipantResultsImpl > impl)
Konstruiert ein ParticipantResults-Objekt aus einem shared_ptr-Element in ein ParticipantResultsImpl-Element.
ParticipantResults(const ParticipantResults & copy_from)
Erstellt eine Kopie eines vorhandenen ParticipantResults-Objekts.
ParticipantResults(ParticipantResults && move_from)
Verschiebt ein vorhandenes ParticipantResults-Objekt.

Öffentliche Funktionen
HasResultsForParticipant(const std::string & participant_id) const
bool
Gibt „true“ zurück, wenn dieses ParticipantResults-Objekt ein Ergebnis für die angegebene MultiplayerParticipant hat.
MatchResultForParticipant(const std::string & participant_id) const
Gibt die MatchResult für den angegebenen Teilnehmer innerhalb einer TurnBasedMatch zurück.
PlaceForParticipant(const std::string & participant_id) const
uint32_t
Gibt die Platzierung des angegebenen Teilnehmers innerhalb eines TurnBasedMatch zurück.
Valid() const
bool
Gibt „true“ zurück, wenn dieses ParticipantResults-Objekt mit Daten gefüllt ist.
WithResult(const std::string & participant_id, uint32_t placing, MatchResult result) const
Erstellt eine neue ParticipantResults, die alle vorhandenen Ergebnisse und die zusätzlichen Ergebnisdaten enthält, die an diese Funktion übergeben wurden.
operator=(const ParticipantResults & copy_from)
Weist dieses ParticipantResults-Objekt einem anderen zu.
operator=(ParticipantResults && move_from)
Weist diesem ParticipantResults-Objekt zu, indem ein anderes in das Objekt verschoben wird.

Öffentliche Funktionen

HasResultsForParticipant

bool HasResultsForParticipant(
  const std::string & participant_id
) const

Gibt „true“ zurück, wenn dieses ParticipantResults-Objekt ein Ergebnis für die angegebene MultiplayerParticipant hat.

Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

MatchResultForParticipant

MatchResult MatchResultForParticipant(
  const std::string & participant_id
) const

Gibt die MatchResult für den angegebenen Teilnehmer innerhalb einer TurnBasedMatch zurück.

Beachten Sie, dass nicht alle Teilnehmer ein MatchResult-Ergebnis erhalten. Wenn HasResultsForParticipant nicht "true" zurückgibt, gibt diese Funktion MatchResult::NONE zurück. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

ParticipantResults

 ParticipantResults()

ParticipantResults

 ParticipantResults(
  std::shared_ptr< const ParticipantResultsImpl > impl
)

Konstruiert ein ParticipantResults-Objekt aus einem shared_ptr-Element in ein ParticipantResultsImpl-Element.

Vorgesehen für die interne Verwendung durch die API.

ParticipantResults

 ParticipantResults(
  const ParticipantResults & copy_from
)

Erstellt eine Kopie eines vorhandenen ParticipantResults-Objekts.

ParticipantResults

 ParticipantResults(
  ParticipantResults && move_from
)

Verschiebt ein vorhandenes ParticipantResults-Objekt.

PlaceForParticipant

uint32_t PlaceForParticipant(
  const std::string & participant_id
) const

Gibt die Platzierung des angegebenen Teilnehmers innerhalb eines TurnBasedMatch zurück.

Beachten Sie, dass nicht alle Teilnehmenden Ergebnisse erhalten können. Wenn HasResultsForParticipant nicht "true" zurückgibt, gibt diese Funktion für einen Spieler, der noch nicht eingestuft wurde, 0 zurück. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

Gültig

bool Valid() const

Gibt „true“ zurück, wenn dieses ParticipantResults-Objekt mit Daten gefüllt ist.

Muss „true“ sein, damit die Getter-Funktionen (PlaceForParticipant, MatchResultForParticipant usw.) für dieses ParticipantResults-Objekt verwendet werden können.

WithResult

ParticipantResults WithResult(
  const std::string & participant_id,
  uint32_t placing,
  MatchResult result
) const

Erstellt eine neue ParticipantResults, die alle vorhandenen Ergebnisse und die zusätzlichen Ergebnisdaten enthält, die an diese Funktion übergeben wurden.

Beachten Sie, dass ein Ergebnis nur einmal pro Teilnehmer festgelegt werden kann. Wenn Sie versuchen, mehr als ein Ergebnis festzulegen, wird ein Fehler protokolliert und ParticipantResults bleibt unverändert. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

Details
Parameter
participant_id
Die MultiplayerParticipant, für die ein Ergebnis hinzugefügt werden soll.
placing
Die Platzierung des Teilnehmers während des Spiels.
result
Die MatchResult für den Teilnehmer während des Spiels.

operator=

ParticipantResults & operator=(
  const ParticipantResults & copy_from
)

Weist dieses ParticipantResults-Objekt einem anderen zu.

operator=

ParticipantResults & operator=(
  ParticipantResults && move_from
)

Weist diesem ParticipantResults-Objekt zu, indem ein anderes in das Objekt verschoben wird.