gpg::TurnBasedMatch

#include <turn_based_match.h>

Uma estrutura de dados que contém dados sobre o estado atual de uma TurnBasedMatch.

Resumo

Construtores e destruidores
TurnBasedMatch()
TurnBasedMatch(std::shared_ptr< const TurnBasedMatchImpl > impl)
Cria um TurnBasedMatch de um shared_ptr para um TurnBasedMatchImpl.
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 horário 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
True se este objeto tiver dados que foram definidos durante uma rodada anterior.
HasPreviousMatchData() const
bool
"True" se esta for a primeira rodada de uma nova correspondência, e os dados do Valid anterior precisam retornar "true" para que essa função seja utilizável.
HasRematchId() const
bool
Retorna "true" se essa correspondência tiver sido feita novamente.
Id() const
const std::string &
Retorna um ID que identifica exclusivamente esse TurnBasedMatch.
LastUpdateTime() const
Retorna o horário em que a TurnBasedMatch foi atualizada pela última vez (expressa em milissegundos desde a época do Unix).
LastUpdatingParticipant() const
Retorna o participante que atualizou esta correspondência mais recentemente.
Number() const
uint32_t
Um número que indica quantas correspondências precederam essa outra via nova correspondência.
ParticipantResults() const
retorna os resultados da correspondência.
Participants() const
const std::vector< MultiplayerParticipant > &
Um vetor de todos os participantes da partida.
PendingParticipant() const
Retorna o participante cuja vez é a vez de atualizar esta correspondência.
PreviousMatchData() const
const std::vector< uint8_t > &
Dados da correspondência anterior, se 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 seleciona um participante válido do conjunto de participantes mesclados, convincentes e com correspondência automática.
Valid() const
bool
Retorna verdadeiro se este TurnBasedMatch for preenchido com dados.
Variant() const
uint32_t
Retorna um identificador de variante específico do jogo que pode ser usado por um jogo para identificar diferentes modos de jogo.
Version() const
uint32_t
Um ID estritamente crescente, 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 espaços 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 horário 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

Retorna os dados de correspondência, se HasData() for verdadeiro.

Valid precisa retornar "true" para que essa função seja utilizável.

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

True se este objeto tiver dados que foram definidos durante uma rodada anterior.

Valid precisa retornar "true" para que essa função seja utilizável.

HasPreviousMatchData

bool HasPreviousMatchData() const

"True" se esta for a primeira rodada de uma nova correspondência, e os dados do Valid anterior precisam retornar "true" para que essa função seja utilizável.

HasRematchId

bool HasRematchId() const

Retorna "true" se essa correspondência tiver sido feita novamente.

ID

const std::string & Id() const

Retorna um ID que identifica exclusivamente esse TurnBasedMatch.

Use com TurnBasedMultiplayerManager::FetchMatch para extrair essa correspondência em um momento posterior. Valid precisa retornar "true" para que essa função seja utilizável.

LastUpdateTime

Timestamp LastUpdateTime() const

Retorna o horário em que a TurnBasedMatch foi atualizada pela última vez (expressa em milissegundos desde a época do Unix).

Valid precisa retornar "true" para que essa função seja utilizável.

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

Retorna o participante que atualizou esta 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 outra via nova correspondência.

é definido como 1 na primeira correspondência e incrementado em um em cada nova correspondência;

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

retorna os resultados da correspondência.

Os resultados podem ser definidos usando TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn e outras funções relacionadas. Sempre use ParticipantResults().WithResult(...) para criar um novo objeto ParticipantResults consistente com os atuais. 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 da partida.

Valid precisa retornar "true" para que essa função seja utilizável.

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Retorna o participante cuja vez é a vez de atualizar esta correspondência.

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, se 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 seleciona um participante válido no conjunto de participantes mesclados, convincentes e com correspondência automática.

Se esta função sempre for usada para selecionar o próximo participante, a reprodução continuará por todos os participantes em ordem, repetindo, se necessário. Essa função só precisará ser chamada se Status() for MatchStatus::MY_TURN, porque essa é a única vez em que o resultado dessa função pode ser usado de maneira significativa. Se for chamada incorretamente, ela retornará um participante inválido (MultiplayerParticipant::Valid() == false).

TurnBasedMatch

 TurnBasedMatch()

TurnBasedMatch

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

Cria um TurnBasedMatch de um shared_ptr para um TurnBasedMatchImpl.

Destinado ao uso interno pela API.

TurnBasedMatch

 TurnBasedMatch(
  const TurnBasedMatch & copy_from
)

Cria uma cópia de um TurnBasedMatch existente.

TurnBasedMatch

 TurnBasedMatch(
  TurnBasedMatch && move_from
)

Move um TurnBasedMatch existente.

Válido

bool Valid() const

Retorna verdadeiro se este TurnBasedMatch for preenchido com dados.

Precisa retornar "true" 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 por um jogo para identificar diferentes modos de jogo.

Valid precisa retornar "true" para que essa função seja utilizável.

Versão

uint32_t Version() const

Um ID estritamente crescente, atualizado sempre que uma correspondência é modificada.

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Atribui este TurnBasedMatch copiando de outro.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Atribui este TurnBasedMatch movendo outro para ele.