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 von einem shared_ptr in einen TurnBasedMatchImpl.
TurnBasedMatch(const TurnBasedMatch & copy_from)
Erstellt eine Kopie eines vorhandenen TurnBasedMatch.
TurnBasedMatch(TurnBasedMatch && move_from)
Verschiebt einen vorhandenen TurnBasedMatch.

Öffentliche Funktionen

AutomatchingSlotsAvailable() const
uint32_t
Gibt die Anzahl der verfügbaren Slots mit automatischer Zuordnung für die Übereinstimmung zurück.
CreatingParticipant() const
Gibt den Teilnehmer zurück, der dieses Spiel erstellt hat
CreationTime() const
std::chrono::milliseconds
Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch was created (in Millisekunden seit der Unix-Epoche) zurückliegt.
Data() const
const std::vector< uint8_t > &
Gibt die Übereinstimmungsdaten zurück, wenn HasData() wahr ist.
Description() const
const std::string &
Gibt eine vom Server generierte Zusammenfassung des Status der Übereinstimmung zurück.
HasData() const
bool
Wahr, wenn dieses Objekt Daten enthält, die in einer vorherigen Abzweigung festgelegt wurden.
HasPreviousMatchData() const
bool
„True“, wenn dies die erste Runde einer Revanche ist und Daten des vorherigen Valid „true“ zurückgeben müssen, damit diese Funktion verwendet werden kann.
HasRematchId() const
bool
Gibt „true“ zurück, wenn diese Übereinstimmung noch einmal zugeordnet wurde.
Id() const
const std::string &
Gibt eine ID zurück, die diesen TurnBasedMatch eindeutig identifiziert.
LastUpdateTime() const
Gibt den Zeitpunkt zurück, zu dem diese TurnBasedMatch zuletzt aktualisiert wurde (in Millisekunden seit der Unix-Epoche).
LastUpdatingParticipant() const
Gibt den Teilnehmer zurück, der dieses Spiel zuletzt aktualisiert hat
Number() const
uint32_t
Zahl, die angibt, wie viele Übereinstimmungen dieser zuvor durch eine erneute Zuordnung vorlagen.
ParticipantResults() const
Gibt die Ergebnisse für die Übereinstimmung zurück.
Participants() const
const std::vector< MultiplayerParticipant > &
Ein Vektor aller Teilnehmer in diesem Spiel.
PendingParticipant() const
Gibt den Teilnehmer zurück, der an der Aktualisierung dieses Spiels ist.
PreviousMatchData() const
const std::vector< uint8_t > &
Daten aus der vorherigen Übereinstimmung, falls HasPreviousMatchData().
RematchId() const
const std::string &
Gibt die ID der Übereinstimmung zurück, bei der es sich um eine Übereinstimmung dieser Übereinstimmung handelt, sofern verfügbar
Status() const
Gibt den Status der Übereinstimmung für den lokalen Teilnehmer zurück
SuggestedNextParticipant() const
Hilfsfunktion, die einen gültigen Teilnehmer aus der Gruppe der beigetretenen, einladenden und automatisch zugeordneten 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 in einem Spiel zur Identifizierung verschiedener Spielmodi verwendet werden kann.
Version() const
uint32_t
Eine strikt inkrementelle ID, die jedes Mal aktualisiert wird, wenn eine Übereinstimmung geändert wird.
operator=(const TurnBasedMatch & copy_from)
Weist dieses TurnBasedMatch durch Kopieren aus einer anderen Domain zu.
operator=(TurnBasedMatch && move_from)
Weist dieses TurnBasedMatch zu, indem ein anderes Element dorthin verschoben wird.

Öffentliche Funktionen

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const 

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

Diese Zahl entspricht der Anzahl der Slots für automatische Zuordnung, mit denen die Übereinstimmung erstellt wurde, abzüglich der Anzahl der Teilnehmer, die bereits durch die automatische Zuordnung hinzugefügt wurden. Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const 

Gibt den Teilnehmer zurück, der dieses Spiel erstellt hat

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

CreationTime

std::chrono::milliseconds CreationTime() const 

Gibt den Zeitpunkt zurück, zu dem dieser TurnBasedMatch was created (in Millisekunden seit der Unix-Epoche) zurückliegt.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Daten

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

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

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Beschreibung

const std::string & Description() const 

Gibt eine vom Server generierte Zusammenfassung des Status der Übereinstimmung zurück.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

HasData

bool HasData() const 

Wahr, wenn dieses Objekt Daten enthält, die in einer vorherigen Abzweigung festgelegt wurden.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

HasPreviousMatchData

bool HasPreviousMatchData() const 

„True“, wenn dies die erste Runde einer Revanche ist und Daten des vorherigen Valid „true“ zurückgeben müssen, damit diese Funktion verwendet werden kann.

HasRematchId

bool HasRematchId() const 

Gibt „true“ zurück, wenn diese Übereinstimmung noch einmal zugeordnet wurde.

ID

const std::string & Id() const 

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

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

LastUpdateTime

Timestamp LastUpdateTime() const 

Gibt den Zeitpunkt zurück, zu dem diese TurnBasedMatch zuletzt aktualisiert wurde (in Millisekunden seit der Unix-Epoche).

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const 

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

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Zahl

uint32_t Number() const 

Zahl, die angibt, wie viele Übereinstimmungen dieser zuvor durch eine erneute Zuordnung vorlagen.

Sie wird in der ersten Übereinstimmung auf 1 gesetzt und bei jeder erneuten Übereinstimmung um 1 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 zugehörige Funktionen festgelegt werden. Verwenden Sie immer ParticipantResults().WithResult(...), um ein neues ParticipantResults-Objekt zu erstellen, das mit vorhandenen Objekten konsistent ist. Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Teilnehmer

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

Ein Vektor aller Teilnehmer in diesem Spiel.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

PendingParticipant

MultiplayerParticipant PendingParticipant() const 

Gibt den Teilnehmer zurück, der an der Aktualisierung dieses Spiels ist.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

PreviousMatchData

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

Daten aus der vorherigen Übereinstimmung, falls HasPreviousMatchData().

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

RematchId

const std::string & RematchId() const 

Gibt die ID der Übereinstimmung zurück, bei der es sich um eine Übereinstimmung dieser Übereinstimmung handelt, sofern verfügbar

Status

MatchStatus Status() const 

Gibt den Status der Übereinstimmung für den lokalen Teilnehmer zurück

Der Status bestimmt, welche Maßnahmen bei der Übereinstimmung ergriffen werden können. Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

SuggestedNextParticipant

MultiplayerParticipant SuggestedNextParticipant() const 

Hilfsfunktion, die einen gültigen Teilnehmer aus der Gruppe der beigetretenen, einladenden und automatisch zugeordneten Teilnehmer auswählt.

Wenn diese Funktion immer verwendet wird, um den nächsten Teilnehmer auszuwählen, werden alle Teilnehmer in der richtigen Reihenfolge abgespielt und bei Bedarf 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 falschem Aufruf gibt die Funktion einen ungültigen Teilnehmer zurück (MultiplayerParticipant::Valid() == false).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Erstellt ein TurnBasedMatch von einem shared_ptr in einen TurnBasedMatchImpl.

Vorgesehen für die interne Verwendung durch die API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Erstellt eine Kopie eines vorhandenen TurnBasedMatch.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Verschiebt einen vorhandenen TurnBasedMatch.

Gültig

bool Valid() const 

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

Muss „true“ zurückgeben, damit die Getter-Funktionen für das TurnBasedMatch-Objekt (Id, CreationTime usw.) verwendet werden können.

Variante

uint32_t Variant() const 

Gibt eine spielspezifische Varianten-ID zurück, die in einem Spiel zur Identifizierung verschiedener Spielmodi verwendet werden kann.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Version

uint32_t Version() const 

Eine strikt inkrementelle ID, die jedes Mal aktualisiert wird, wenn eine Übereinstimmung geändert wird.

Operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Weist dieses TurnBasedMatch durch Kopieren aus einer anderen Domain zu.

Operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Weist dieses TurnBasedMatch zu, indem ein anderes Element dorthin verschoben wird.