gpg:: TurnBasedMatch
#include <turn_based_match.h>
Una struttura di dati contenente dati sullo stato attuale di un 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 slot 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
TurnBasedMatch was created (espresso in millisecondi dall'epoca di Unix). |
Data() const
|
const std::vector< uint8_t > &
Restituisce i dati di corrispondenza, se
HasData() è vero. |
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 della campagna Valid precedente devono restituire true se questa funzione è utilizzabile.
|
HasRematchId() const
|
bool
Restituisce true se questa corrispondenza è stata abbinata di nuovo.
|
Id() const
|
const std::string &
Restituisce un ID che identifica in modo univoco questo
TurnBasedMatch . |
LastUpdateTime() const
|
Restituisce l'ora in cui l'elemento
TurnBasedMatch è stato aggiornato per l'ultima volta, espresso 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 hanno preceduto questa tramite rivincita.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Restituisce i risultati per la corrispondenza.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Un vettore di tutti i partecipanti a questa partita.
|
PendingParticipant() const
|
Restituisce il partecipante di cui è il turno di aggiornare questa partita.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Dati della corrispondenza precedente, se HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Restituisce l'ID della corrispondenza che è una rivincita di questa corrispondenza, se disponibile.
|
Status() const
|
Restituisce lo stato della corrispondenza per il partecipante locale.
|
SuggestedNextParticipant() const
|
Una funzione di supporto che sceglie un partecipante valido dall'insieme di partecipanti uniti, invitabili e con corrispondenza automatica.
|
Valid() const
|
bool
Restituisce true se l'elemento
TurnBasedMatch è compilato con i dati. |
Variant() const
|
uint32_t
Restituisce un identificatore di variante specifico del gioco che può essere utilizzato da un gioco per identificare diverse modalità di gioco.
|
Version() const
|
uint32_t
Un ID rigorosamente incrementale, aggiornato ogni volta che una corrispondenza viene modificata.
|
operator=(const TurnBasedMatch & copy_from)
|
Assegna questo
TurnBasedMatch copiandolo da un altro dispositivo. |
operator=(TurnBasedMatch && move_from)
|
Assegna questo
TurnBasedMatch spostandone un altro al suo interno. |
Funzioni pubbliche
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Restituisce il numero di slot con corrispondenza automatica disponibili per la corrispondenza.
Questo numero è uguale al numero di slot con corrispondenza automatica con cui è stata creata la partita, meno il numero di partecipanti che sono già stati aggiunti tramite la corrispondenza automatica. Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Restituisce il partecipante che ha creato questa corrispondenza.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
CreationTime
std::chrono::milliseconds CreationTime() const
Restituisce l'ora in cui TurnBasedMatch was created
(espresso in millisecondi dall'epoca di Unix).
Valido deve restituire true per consentire a questa funzione di essere 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 per consentire a questa funzione di essere utilizzabile.
HasData
bool HasData() const
True se l'oggetto contiene dati impostati durante una svolta precedente.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
HasPreviousMatchData
bool HasPreviousMatchData() const
True se si tratta del primo turno di una rivincita e i dati della campagna Valid precedente devono restituire true se questa funzione è utilizzabile.
HasRematchId
bool HasRematchId() const
Restituisce true se questa corrispondenza è stata abbinata di nuovo.
ID
const std::string & Id() const
Restituisce un ID che identifica in modo univoco questo TurnBasedMatch
.
Utilizzala con TurnBasedMultiplayerManager::FetchMatch
per recuperare questa corrispondenza in un secondo momento. Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
LastUpdateTime
Timestamp LastUpdateTime() const
Restituisce l'ora in cui l'elemento TurnBasedMatch
è stato aggiornato per l'ultima volta, espresso in millisecondi dall'epoca di Unix.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Restituisce il partecipante che ha aggiornato più di recente questa corrispondenza.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
Numero
uint32_t Number() const
Un numero che indica quante corrispondenze hanno preceduto questa tramite rivincita.
È impostato su 1 per la prima corrispondenza e incrementato di 1 per ogni rivincita.
ParticipantResults
const gpg::ParticipantResults & ParticipantResults() const
Restituisce i risultati per la 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 per consentire a questa funzione di essere utilizzabile.
Partecipanti
const std::vector< MultiplayerParticipant > & Participants() const
Un vettore di tutti i partecipanti a questa partita.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Restituisce il partecipante di cui è il turno di aggiornare questa partita.
Valido deve restituire true per consentire a questa funzione di essere 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 è una rivincita di questa corrispondenza, se disponibile.
Stato
MatchStatus Status() const
Restituisce lo stato della corrispondenza per il partecipante locale.
Lo stato determina quali azioni possono essere intraprese sulla corrispondenza. Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Una funzione di supporto che sceglie 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 continuerà in ordine tra tutti i partecipanti e, se necessario, si ripeterà. Questa funzione deve essere chiamata solo se Status() è MatchStatus::MY_TURN, poiché è l'unica volta in cui il risultato di questa funzione può essere utilizzato in modo significativo. Se chiamata in modo errato, questa funzione restituisce un partecipante non valido (MultiplayerParticipant::Valid() == false
).
TurnBasedMatch
TurnBasedMatch()
TurnBasedMatch
TurnBasedMatch( std::shared_ptr< const TurnBasedMatchImpl > impl )
Crea un TurnBasedMatch
da shared_ptr
a TurnBasedMatchImpl
.
Destinato per uso interno dall'API.
TurnBasedMatch
TurnBasedMatch( const TurnBasedMatch & copy_from )
Crea una copia di un TurnBasedMatch
esistente.
TurnBasedMatch
TurnBasedMatch( TurnBasedMatch && move_from )
Sposta un elemento TurnBasedMatch
esistente.
Valido
bool Valid() const
Restituisce true se l'elemento TurnBasedMatch
è compilato con i dati.
Deve restituire true affinché le funzioni getter sull'oggetto TurnBasedMatch
(Id
, CreationTime
e così via) siano utilizzabili.
Variante
uint32_t Variant() const
Restituisce un identificatore di variante specifico del gioco che può essere utilizzato da un gioco per identificare diverse modalità di gioco.
Valido deve restituire true per consentire a questa funzione di essere utilizzabile.
Versione
uint32_t Version() const
Un ID rigorosamente incrementale, aggiornato ogni volta che una corrispondenza viene modificata.
operator=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Assegna questo TurnBasedMatch
copiandolo da un altro dispositivo.
operator=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Assegna questo TurnBasedMatch
spostandone un altro al suo interno.