gpg::TurnBasedMatch

#include <turn_based_match.h>

Eine Datenstruktur mit Daten zum aktuellen Status einer TurnBasedMatch.

Zusammenfassung

Konstruktoren und Zerstörer
TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
Erstellt ein TurnBasedMatch aus einem shared_ptr zu einem TurnBasedMatchImpl.
TurnBasedMatch(const TurnBasedMatch & copy_from)
Erstellt eine Kopie einer vorhandenen TurnBasedMatch.
TurnBasedMatch(TurnBasedMatch && move_from)
Verschiebt ein vorhandenes TurnBasedMatch.

Öffentliche Funktionen
AutomatchingSlotsAvailable() const
uint32_t
Gibt die Anzahl der verfügbaren Slots für die automatische Zuordnung für die Übereinstimmung zurück.
CreatingParticipant() const
Gibt den Teilnehmer zurück, der diese Übereinstimmung erstellt hat
CreationTime() const
std::chrono::milliseconds
Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch was created (ausgedrückt als Millisekunden seit der Unix-Epoche) zurückgegeben wird.
Data() const
const std::vector< uint8_t > &
Gibt die Abgleichsdaten zurück, wenn HasData() wahr ist.
Description() const
const std::string &
Gibt eine vom Server generierte Zusammenfassung des Übereinstimmungsstatus zurück.
HasData() const
bool
„True“, wenn dieses Objekt Daten enthält, die während eines früheren Trainings festgelegt wurden.
HasPreviousMatchData() const
bool
"True", wenn dies die erste Runde einer Revanche ist und Daten aus der vorherigen Valid-Funktion "true" zurückgeben müssen, damit diese Funktion verwendet werden kann.
HasRematchId() const
bool
Gibt "true" zurück, wenn diese Übereinstimmung erneut zugeordnet wurde.
Id() const
const std::string &
Gibt eine ID zurück, die dieses TurnBasedMatch eindeutig identifiziert.
LastUpdateTime() const
Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch zuletzt aktualisiert wurde (ausgedrückt als Millisekunden seit der Unix-Epoche).
LastUpdatingParticipant() const
Gibt den Teilnehmer zurück, der dieses Spiel zuletzt aktualisiert hat.
Number() const
uint32_t
Eine Zahl, die angibt, wie viele Übereinstimmungen dieser Suche durch Revanche vorausgegangen sind.
ParticipantResults() const
Gibt die Ergebnisse für die Übereinstimmung zurück.
Participants() const
const std::vector< MultiplayerParticipant > &
Ein Vektor aller Teilnehmer an diesem Spiel.
PendingParticipant() const
Gibt den Teilnehmer zurück, der an der Reihe ist, um dieses Spiel zu aktualisieren.
PreviousMatchData() const
const std::vector< uint8_t > &
Daten aus der vorherigen Übereinstimmung, wenn HasPreviousMatchData() ausgewählt wurde.
RematchId() const
const std::string &
Gibt die ID der Übereinstimmung zurück, die eine Revanche dieser Übereinstimmung ist, sofern verfügbar
Status() const
Gibt den Spielstatus für den lokalen Teilnehmer zurück.
SuggestedNextParticipant() const
Eine Hilfsfunktion, die einen gültigen Teilnehmer aus der Gruppe der teilnehmenden, einleitenden und automatisch zuordnenden Teilnehmer auswählt.
Valid() const
bool
Gibt „true“ zurück, wenn TurnBasedMatch mit Daten gefüllt ist.
Variant() const
uint32_t
Gibt eine spielspezifische Varianten-ID zurück, die von einem Spiel verwendet werden kann, um verschiedene Spielmodi zu identifizieren.
Version() const
uint32_t
Eine streng inkrementelle ID, die bei jeder Änderung einer Übereinstimmung aktualisiert wird.
operator=(const TurnBasedMatch & copy_from)
Weist diesem/dieser TurnBasedMatch durch Kopieren aus einem anderen zu.
operator=(TurnBasedMatch && move_from)
Weist diesem TurnBasedMatch zu, indem eine andere in die Datei verschoben wird.

Öffentliche Funktionen

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

Gibt die Anzahl der verfügbaren Slots für die automatische Zuordnung für die Übereinstimmung zurück.

Diese Anzahl entspricht der Anzahl der automatisch passenden Slots, mit denen das Spiel erstellt wurde, abzüglich der Anzahl der Teilnehmer, die bereits durch die automatische Zuordnung hinzugefügt wurden. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

Gibt den Teilnehmer zurück, der diese Übereinstimmung erstellt hat

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

CreationTime

std::chrono::milliseconds CreationTime() const

Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch was created (ausgedrückt als Millisekunden seit der Unix-Epoche) zurückgegeben wird.

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

Daten

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

Gibt die Abgleichsdaten zurück, wenn HasData() wahr ist.

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

Beschreibung

const std::string & Description() const

Gibt eine vom Server generierte Zusammenfassung des Übereinstimmungsstatus zurück.

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

HasData

bool HasData() const

„True“, wenn dieses Objekt Daten enthält, die während eines früheren Trainings festgelegt wurden.

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

HasPreviousMatchData

bool HasPreviousMatchData() const

"True", wenn dies die erste Runde einer Revanche ist und Daten aus der vorherigen Valid-Funktion "true" zurückgeben müssen, damit diese Funktion verwendet werden kann.

HasRematchId

bool HasRematchId() const

Gibt "true" zurück, wenn diese Übereinstimmung erneut abgeglichen wurde.

ID

const std::string & Id() const

Gibt eine ID zurück, die dieses TurnBasedMatch eindeutig identifiziert.

Wird mit TurnBasedMultiplayerManager::FetchMatch verwendet, um diese Übereinstimmung später abzurufen. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

LastUpdateTime

Timestamp LastUpdateTime() const

Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch zuletzt aktualisiert wurde (ausgedrückt als Millisekunden seit der Unix-Epoche).

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

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

Gibt den Teilnehmer zurück, der dieses Spiel zuletzt aktualisiert hat.

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

Zahl

uint32_t Number() const

Eine Zahl, die angibt, wie viele Übereinstimmungen dieser Suche durch Revanche vorausgegangen sind.

Wird bei der ersten Übereinstimmung auf 1 festgelegt und bei jeder erneuten Übereinstimmung um eins erhöht.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

Gibt die Ergebnisse für die Übereinstimmung zurück.

Ergebnisse können über TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn und andere verwandte Funktionen festgelegt werden. Verwenden Sie immer ParticipantResults().WithResult(...), um ein neues ParticipantResults-Objekt zu erstellen, das mit bereits vorhandenen konsistent ist. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

Teilnehmer

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

Ein Vektor aller Teilnehmer an diesem Spiel.

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

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Gibt den Teilnehmer zurück, der an der Reihe ist, um dieses Spiel zu aktualisieren.

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

PreviousMatchData

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

Daten aus der vorherigen Übereinstimmung, wenn HasPreviousMatchData() ausgewählt wurde.

Kann nur aufgerufen werden, wenn Valid den Wert „true“ zurückgibt.

RematchId

const std::string & RematchId() const

Gibt die ID der Übereinstimmung zurück, die eine Revanche dieser Übereinstimmung ist, sofern verfügbar

Status

MatchStatus Status() const

Gibt den Spielstatus für den lokalen Teilnehmer zurück.

Der Status bestimmt, welche Aktionen für die Übereinstimmung ausgeführt werden können. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const

Eine Hilfsfunktion, die einen gültigen Teilnehmer aus der Gruppe der teilnehmenden, einleitenden und automatisch zuordnenden Teilnehmer auswählt.

Wenn diese Funktion immer verwendet wird, um den nächsten Teilnehmer auszuwählen, werden alle Teilnehmer der Reihe nach abgespielt. Gegebenenfalls wird die Wiedergabe wiederholt. Diese Funktion darf nur aufgerufen werden, wenn Status() MatchStatus::MY_TURN ist, da das Ergebnis dieser Funktion nur dann sinnvoll verwendet werden kann. Bei einem falschen Aufruf gibt diese Funktion einen ungültigen Teilnehmer (MultiplayerParticipant::Valid() == false) zurück.

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Erstellt ein TurnBasedMatch aus einem shared_ptr zu einem TurnBasedMatchImpl.

Vorgesehen für die interne Verwendung durch die API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Erstellt eine Kopie einer vorhandenen TurnBasedMatch.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Verschiebt ein vorhandenes TurnBasedMatch.

Gültig

bool Valid() const

Gibt „true“ zurück, wenn TurnBasedMatch mit Daten gefüllt ist.

Damit die Getter-Funktionen im TurnBasedMatch-Objekt (Id, CreationTime usw.) verwendet werden können, muss „true“ zurückgegeben werden.

Variante

uint32_t Variant() const

Gibt eine spielspezifische Varianten-ID zurück, die von einem Spiel verwendet werden kann, um verschiedene Spielmodi zu identifizieren.

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

Version

uint32_t Version() const

Eine streng inkrementelle ID, die bei jeder Änderung einer Übereinstimmung aktualisiert wird.

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Weist diesem/dieser TurnBasedMatch durch Kopieren aus einem anderen zu.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Weist diesem TurnBasedMatch zu, indem eine andere in die Datei verschoben wird.