gpg:: TurnBasedMatch
#include <turn_based_match.h>
Uma estrutura de dados contendo dados sobre o estado atual de uma TurnBasedMatch
.
Resumo
Construtores e destrutores |
|
---|---|
TurnBasedMatch()
|
|
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
|
|
TurnBasedMatch(const TurnBasedMatch & copy_from)
Cria uma cópia de um
TurnBasedMatch existente. |
|
TurnBasedMatch(TurnBasedMatch && move_from)
Move um
TurnBasedMatch existente. |
Funções públicas |
|
---|---|
AutomatchingSlotsAvailable() const
|
uint32_t
Retorna o número de espaços de correspondência automática disponíveis para a correspondência.
|
CreatingParticipant() const
|
Retorna o participante que criou essa correspondência.
|
CreationTime() const
|
std::chrono::milliseconds
Retorna o tempo em que esse
TurnBasedMatch was created (expresso em milissegundos desde a época do Unix). |
Data() const
|
const std::vector< uint8_t > &
Retorna os dados de correspondência, se
HasData() for verdadeiro. |
Description() const
|
const std::string &
Retorna um resumo gerado pelo servidor do estado da correspondência.
|
HasData() const
|
bool
Verdadeiro se esse objeto tiver dados que foram definidos durante uma curva anterior.
|
HasPreviousMatchData() const
|
bool
"True", se esta for a primeira vez que uma nova partida é feita e os dados do Valid anterior precisam retornar verdadeiro para que essa função seja utilizável.
|
HasRematchId() const
|
bool
Retorna verdadeiro se essa correspondência tiver sido nova.
|
Id() const
|
const std::string &
Retorna um ID que identifica exclusivamente esse
TurnBasedMatch . |
LastUpdateTime() const
|
Retorna a hora em que esse
TurnBasedMatch foi atualizado pela última vez, expresso em milissegundos desde a época Unix. |
LastUpdatingParticipant() const
|
Retorna o participante que atualizou a correspondência mais recentemente.
|
Number() const
|
uint32_t
Um número que indica quantas correspondências precederam essa com a nova correspondência.
|
ParticipantResults() const
|
const gpg::ParticipantResults &
Retorna os resultados da correspondência.
|
Participants() const
|
const std::vector< MultiplayerParticipant > &
Um vetor de todos os participantes desta partida.
|
PendingParticipant() const
|
Retorna o participante de quem é a vez de atualizar a partida.
|
PreviousMatchData() const
|
const std::vector< uint8_t > &
Dados da correspondência anterior, no caso HasPreviousMatchData().
|
RematchId() const
|
const std::string &
Retorna o ID da correspondência que é uma nova correspondência, se disponível.
|
Status() const
|
Retorna o status da correspondência para o participante local.
|
SuggestedNextParticipant() const
|
Uma função auxiliar que escolhe um participante válido do conjunto de participantes mesclados, convidados e de correspondência automática.
|
Valid() const
|
bool
Retorna verdadeiro se
TurnBasedMatch for preenchido com dados. |
Variant() const
|
uint32_t
Retorna um identificador de variante específico do jogo que pode ser usado para identificar diferentes modos.
|
Version() const
|
uint32_t
Um ID estritamente incrementado, atualizado sempre que uma correspondência é modificada.
|
operator=(const TurnBasedMatch & copy_from)
|
Atribui este
TurnBasedMatch copiando de outro. |
operator=(TurnBasedMatch && move_from)
|
Atribui este
TurnBasedMatch movendo outro para ele. |
Funções públicas
AutomatchingSlotsAvailable
uint32_t AutomatchingSlotsAvailable() const
Retorna o número de espaços de correspondência automática disponíveis para a correspondência.
Esse número é igual ao número de slots de correspondência automática com os quais a correspondência foi criada menos o número de participantes que já foram adicionados pela correspondência automática. Valid precisa retornar true para que essa função seja utilizável.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Retorna o participante que criou essa correspondência.
Valid precisa retornar true para que essa função seja utilizável.
CreationTime
std::chrono::milliseconds CreationTime() const
Retorna o tempo em que esse TurnBasedMatch was created
(expresso em milissegundos desde a época do Unix).
Valid precisa retornar true para que essa função seja utilizável.
Dados
const std::vector< uint8_t > & Data() const
Descrição
const std::string & Description() const
Retorna um resumo gerado pelo servidor do estado da correspondência.
Valid precisa retornar true para que essa função seja utilizável.
HasData
bool HasData() const
Verdadeiro se esse objeto tiver dados que foram definidos durante uma curva anterior.
Valid precisa retornar true para que essa função seja utilizável.
HasPreviousMatchData
bool HasPreviousMatchData() const
"True", se esta for a primeira vez que uma nova partida é feita e os dados do Valid anterior precisam retornar verdadeiro para que essa função seja utilizável.
HasRematchId
bool HasRematchId() const
Retorna verdadeiro se essa correspondência tiver sido nova.
ID
const std::string & Id() const
Retorna um ID que identifica exclusivamente esse TurnBasedMatch
.
Use com TurnBasedMultiplayerManager::FetchMatch
para recuperar essa correspondência posteriormente. Valid precisa retornar true para que essa função seja utilizável.
LastUpdateTime
Timestamp LastUpdateTime() const
Retorna a hora em que esse TurnBasedMatch
foi atualizado pela última vez, expresso em milissegundos desde a época Unix.
Valid precisa retornar true para que essa função seja utilizável.
LastUpdatingParticipant
MultiplayerParticipant LastUpdatingParticipant() const
Retorna o participante que atualizou a correspondência mais recentemente.
Valid precisa retornar true para que essa função seja utilizável.
Número
uint32_t Number() const
Um número que indica quantas correspondências precederam essa com a nova correspondência.
É definido como 1 na primeira partida e incrementado em um em cada nova partida.
ParticipantResults
const gpg::ParticipantResults & ParticipantResults() const
Retorna os resultados da correspondência.
Os resultados podem ser definidos com TurnBasedMultiplayerManager::TakeMyTurn
, TurnBasedMultiplayerManager::FinishDuringMyTurn
e outras funções relacionadas. Sempre use ParticipantResults().WithResult(...)
para criar um novo objeto ParticipantResults
consistente com os já existentes. Valid precisa retornar true para que essa função seja utilizável.
Participantes
const std::vector< MultiplayerParticipant > & Participants() const
Um vetor de todos os participantes desta partida.
Valid precisa retornar true para que essa função seja utilizável.
PendingParticipant
MultiplayerParticipant PendingParticipant() const
Retorna o participante de quem é a vez de atualizar a partida.
Valid precisa retornar true para que essa função seja utilizável.
PreviousMatchData
const std::vector< uint8_t > & PreviousMatchData() const
Dados da correspondência anterior, no caso HasPreviousMatchData().
Só pode ser chamado se Valid retornar "true".
RematchId
const std::string & RematchId() const
Retorna o ID da correspondência que é uma nova correspondência, se disponível.
Status
MatchStatus Status() const
Retorna o status da correspondência para o participante local.
O status determina quais ações podem ser realizadas na correspondência. Valid precisa retornar true para que essa função seja utilizável.
SuggestedNextParticipant
MultiplayerParticipant SuggestedNextParticipant() const
Uma função auxiliar que escolhe um participante válido do conjunto de participantes mesclados, convidados e de correspondência automática.
Se esta função for sempre usada para selecionar o próximo participante, a reprodução será feita com todos os participantes em ordem, repetindo se necessário. Essa função só poderá ser chamada se Status() for MatchStatus::MY_TURN, já que essa é a única vez em que o resultado dessa função pode ser usado de maneira significativa. Se chamada incorretamente, essa função retorna um participante inválido (MultiplayerParticipant::Valid() == false
).
TurnBasedMatch
TurnBasedMatch()
TurnBasedMatch
TurnBasedMatch( std::shared_ptr< const TurnBasedMatchImpl > impl )
Constrói um TurnBasedMatch
de um shared_ptr
a um TurnBasedMatchImpl
.
Destinado ao uso interno da API.
TurnBasedMatch
TurnBasedMatch( const TurnBasedMatch & copy_from )
Cria uma cópia de um TurnBasedMatch
existente.
Válida
bool Valid() const
Retorna verdadeiro se TurnBasedMatch
for preenchido com dados.
Precisa retornar verdadeiro para que as funções getter no objeto TurnBasedMatch
(Id
, CreationTime
etc.) possam ser usadas.
Variante
uint32_t Variant() const
Retorna um identificador de variante específico do jogo que pode ser usado para identificar diferentes modos.
Valid precisa retornar true para que essa função seja utilizável.
Versão
uint32_t Version() const
Um ID estritamente incrementado, atualizado sempre que uma correspondência é modificada.
operador=
TurnBasedMatch & operator=( const TurnBasedMatch & copy_from )
Atribui este TurnBasedMatch
copiando de outro.
operador=
TurnBasedMatch & operator=( TurnBasedMatch && move_from )
Atribui este TurnBasedMatch
movendo outro para ele.