gpg:: TurnBasedMatch
#include <turn_based_match.h>
Una struttura di dati contenente dati sullo stato attuale di un elemento TurnBasedMatch
.
Riepilogo
Costruttori e distruttori |
|
---|---|
TurnBasedMatch()
|
|
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
Crea una copia di un
TurnBasedMatch esistente. |
|
TurnBasedMatch(TurnBasedMatch && move_from)
Sposta un elemento
TurnBasedMatch esistente. |
Funzioni pubbliche |
|
---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
Restituisce il numero di aree con corrispondenza automatica disponibili per la corrispondenza.
|
CreatingParticipant() const
|
Restituisce il partecipante che ha creato questa corrispondenza.
|
CreationTime() const
|
std::chrono::milliseconds
Restituisce l'ora in cui questo
TurnBasedMatch was created (espresso in millisecondi dall'epoca di Unix). |
Data() const
|
const std::vector< uint8_t > &
Restituisce i dati di corrispondenza, se
HasData() è true. |
Description() const
|
const std::string &
Restituisce un riepilogo generato dal server dello stato della corrispondenza.
|
HasData() const
|
bool
True se l'oggetto contiene dati impostati durante una svolta precedente.
|
HasPreviousMatchData() const
|
bool
True se si tratta del primo turno di una rivincita e i dati dell'elemento Valid precedente devono restituire true affinché questa funzione sia utilizzabile.
|
HasRematchId() const
|
bool
Restituisce true se è stata trovata una nuova corrispondenza per questa corrispondenza.
|
Id() const
|
const std::string &
Restituisce un ID che identifica in modo univoco questo
TurnBasedMatch . |
LastUpdateTime() const
|
Restituisce l'ora dell'ultimo aggiornamento di
TurnBasedMatch (espressa in millisecondi dall'epoca di Unix). |
LastUpdatingParticipant() const
|
Restituisce il partecipante che ha aggiornato più di recente questa corrispondenza.
|
Number() const
|
uint32_t
Un numero che indica quante corrispondenze sono state precedute da questa rivincita.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Restituisce i risultati della corrispondenza.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Un vettore di tutti i partecipanti a questa partita.
|
PendingParticipant() const
|
Restituisce il partecipante a cui è il turno di aggiornare questa corrispondenza.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Dati della corrispondenza precedente, se HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Restituisce l'ID della corrispondenza che rappresenta una rivincita della corrispondenza, se disponibile.
|
Status() const
|
Restituisce lo stato della corrispondenza per il partecipante locale.
|
SuggestedNextParticipant() const
|
Una funzione helper che seleziona un partecipante valido dall'insieme di partecipanti uniti, invitabili e con corrispondenza automatica.
|
Valid() const
|
bool
Restituisce true se questo
TurnBasedMatch è completato con dati. |
Variant() const
|
uint32_t
Restituisce un identificatore di variante specifico per il gioco che può essere utilizzato da un gioco per identificare le diverse modalità di gioco.
|
Version() const
|
uint32_t
Un ID con incremento fisso, aggiornato ogni volta che viene modificata una corrispondenza.
|
operator=(const TurnBasedMatch & copy_from)
|
Assegna questo
TurnBasedMatch copiando da un altro. |
operator=(TurnBasedMatch && move_from)
|
Assegna questo
TurnBasedMatch spostandone un altro al suo interno. |
Funzioni pubbliche
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Restituisce il numero di aree con corrispondenza automatica disponibili per la corrispondenza.
Questo numero corrisponde al numero di spazi con corrispondenza automatica con cui è stata creata la corrispondenza, meno il numero di partecipanti che sono già stati aggiunti tramite la corrispondenza automatica. Valido deve restituire true affinché questa funzione sia utilizzabile.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Restituisce il partecipante che ha creato questa corrispondenza.
Valido deve restituire true affinché questa funzione sia utilizzabile.
CreationTime
std::chrono::milliseconds CreationTime() const
Restituisce l'ora in cui questo TurnBasedMatch was created
(espresso in millisecondi dall'epoca di Unix).
Valido deve restituire true affinché questa funzione sia utilizzabile.
Dati
const std::vector< uint8_t > & Data() const
Descrizione
const std::string & Description() const
Restituisce un riepilogo generato dal server dello stato della corrispondenza.
Valido deve restituire true affinché questa funzione sia utilizzabile.
HasData
bool HasData() const
True se l'oggetto contiene dati impostati durante una svolta precedente.
Valido deve restituire true affinché questa funzione sia utilizzabile.
HasPreviousMatchData
bool HasPreviousMatchData() const
True se si tratta del primo turno di una rivincita e i dati dell'elemento Valid precedente devono restituire true affinché questa funzione sia utilizzabile.
HasRematchId
bool HasRematchId() const
Restituisce true se è stata trovata una nuova corrispondenza per questa corrispondenza.
ID
const std::string & Id() const
Restituisce un ID che identifica in modo univoco questo TurnBasedMatch
.
Utilizzalo con TurnBasedMultiplayerManager::FetchMatch
per recuperare questa corrispondenza in un secondo momento. Valido deve restituire true affinché questa funzione sia utilizzabile.
LastUpdateTime
Timestamp LastUpdateTime() const
Restituisce l'ora dell'ultimo aggiornamento di TurnBasedMatch
(espressa in millisecondi dall'epoca di Unix).
Valido deve restituire true affinché questa funzione sia utilizzabile.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Restituisce il partecipante che ha aggiornato più di recente questa corrispondenza.
Valido deve restituire true affinché questa funzione sia utilizzabile.
Numero
uint32_t Number() const
Un numero che indica quante corrispondenze sono state precedute da questa rivincita.
Viene impostato su 1 alla prima partita e incrementato di uno per ogni rivincita.
ParticipantResults
const gpg::ParticipantResults & ParticipantResults() const
Restituisce i risultati della corrispondenza.
I risultati possono essere impostati tramite TurnBasedMultiplayerManager::TakeMyTurn
, TurnBasedMultiplayerManager::FinishDuringMyTurn
e altre funzioni correlate. Usa sempre ParticipantResults().WithResult(...)
per creare un nuovo oggetto ParticipantResults
coerente con quelli esistenti. Valido deve restituire true affinché questa funzione sia utilizzabile.
Partecipanti
const std::vector< MultiplayerParticipant > & Participants() const
Un vettore di tutti i partecipanti a questa partita.
Valido deve restituire true affinché questa funzione sia utilizzabile.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Restituisce il partecipante a cui è il turno di aggiornare questa corrispondenza.
Valido deve restituire true affinché questa funzione sia utilizzabile.
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
Dati della corrispondenza precedente, se HasPreviousMatchData().
Può essere chiamato solo se Valid restituisce true.
RematchId
const std::string & RematchId() const
Restituisce l'ID della corrispondenza che rappresenta una rivincita della corrispondenza, se disponibile.
Stato
MatchStatus Status() const
Restituisce lo stato della corrispondenza per il partecipante locale.
Lo stato determina quali azioni possono essere intraprese in merito alla corrispondenza. Valido deve restituire true affinché questa funzione sia utilizzabile.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Una funzione helper che seleziona un partecipante valido dall'insieme di partecipanti uniti, invitabili e con corrispondenza automatica.
Se questa funzione viene sempre utilizzata per selezionare il partecipante successivo, la riproduzione procederà tra tutti i partecipanti in ordine, ripetendo se necessario. Questa funzione deve essere chiamata solo se Status() è MatchStatus::MY_TURN, poiché questa è l'unica volta in cui il risultato di questa funzione può essere utilizzato in modo significativo. Se chiamata in modo errato, questa funzione restituirà un partecipante non valido (MultiplayerParticipant::Valid() == false
).
TurnBasedMatch
TurnBasedMatch()
TurnBasedMatch
TurnBasedMatch( std::shared_ptr< const TurnBasedMatchImpl > impl )
Crea un TurnBasedMatch
da un shared_ptr
a un TurnBasedMatchImpl
.
Destinato all'uso interno da parte dell'API.
TurnBasedMatch
TurnBasedMatch( const TurnBasedMatch & copy_from )
Crea una copia di un TurnBasedMatch
esistente.
TurnBasedMatch
TurnBasedMatch( TurnBasedMatch && move_from )
Sposta un elemento TurnBasedMatch
esistente.
Valida
bool Valid() const
Restituisce true se questo TurnBasedMatch
è completato con dati.
Deve restituire true affinché le funzioni getter nell'oggetto TurnBasedMatch
(Id
, CreationTime
e così via) siano utilizzabili.
Variante
uint32_t Variant() const
Restituisce un identificatore di variante specifico per il gioco che può essere utilizzato da un gioco per identificare le diverse modalità di gioco.
Valido deve restituire true affinché questa funzione sia utilizzabile.
Versione
uint32_t Version() const
Un ID con incremento fisso, aggiornato ogni volta che viene modificata una corrispondenza.
operatore=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Assegna questo TurnBasedMatch
copiando da un altro.
operatore=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Assegna questo TurnBasedMatch
spostandone un altro al suo interno.