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 destrutores
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 slots de correspondência automática disponíveis para a correspondência.
CreatingParticipant() const
Retorna o participante que criou a correspondência.
CreationTime() const
std::chrono::milliseconds
Retorna o horário em que TurnBasedMatch was created (expresso em milissegundos desde a época 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 o objeto tiver dados definidos durante uma rodada anterior.
HasPreviousMatchData() const
bool
Verdadeiro se esta é a primeira vez de uma revanche, e os dados do Valid anterior precisam retornar verdadeiro para que essa função seja utilizável.
HasRematchId() const
bool
Retorna verdadeiro se a partida foi refeita.
Id() const
const std::string &
Retorna um ID que identifica exclusivamente essa TurnBasedMatch.
LastUpdateTime() const
Retorna a hora em que o TurnBasedMatch foi atualizado pela última vez (expressa em milissegundos desde a época Unix).
LastUpdatingParticipant() const
Retorna o participante que atualizou essa correspondência mais recentemente.
Number() const
uint32_t
Um número que indica quantas partidas precederam essa por rematch.
ParticipantResults() const
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 que tem a vez de atualizar essa correspondência.
PreviousMatchData() const
const std::vector< uint8_t > &
Dados da partida anterior, se HasPreviousMatchData().
RematchId() const
const std::string &
Retorna o ID da partida que é uma revanche, 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 conectados, que podem ser convidados e que correspondem automaticamente.
Valid() const
bool
Retorna verdadeiro se o 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 de jogo.
Version() const
uint32_t
Um ID estritamente incremental, atualizado sempre que uma correspondência é modificada.
operator=(const TurnBasedMatch & copy_from)
Atribui essa TurnBasedMatch copiando de outra.
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 slots 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 que a correspondência foi criada, menos o número de participantes que já foram adicionados por correspondência automática. Valid precisa retornar verdadeiro para que essa função seja utilizável.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

Retorna o participante que criou a correspondência.

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

CreationTime

std::chrono::milliseconds CreationTime() const

Retorna o horário em que TurnBasedMatch was created (expresso em milissegundos desde a época Unix).

Valid precisa retornar verdadeiro 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 verdadeiro 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 verdadeiro para que essa função seja utilizável.

HasData

bool HasData() const

Verdadeiro se o objeto tiver dados definidos durante uma rodada anterior.

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

HasPreviousMatchData

bool HasPreviousMatchData() const

Verdadeiro se esta é a primeira vez de uma revanche, e os dados do Valid anterior precisam retornar verdadeiro para que essa função seja utilizável.

HasRematchId

bool HasRematchId() const

Retorna verdadeiro se a partida foi refeita.

ID

const std::string & Id() const

Retorna um ID que identifica exclusivamente essa TurnBasedMatch.

Use com TurnBasedMultiplayerManager::FetchMatch para recuperar essa correspondência mais tarde. Valid precisa retornar verdadeiro para que essa função seja utilizável.

LastUpdateTime

Timestamp LastUpdateTime() const

Retorna a hora em que o TurnBasedMatch foi atualizado pela última vez (expressa em milissegundos desde a época Unix).

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

LastUpdatingParticipant

MultiplayerParticipant LastUpdatingParticipant() const

Retorna o participante que atualizou essa correspondência mais recentemente.

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

Número

uint32_t Number() const

Um número que indica quantas partidas precederam essa por meio de repetição.

É definido como 1 na primeira correspondência e é incrementado em um em cada revanche.

ParticipantResults

const gpg::ParticipantResults & ParticipantResults() const

Retorna os resultados da correspondência.

Os resultados podem ser definidos por TurnBasedMultiplayerManager::TakeMyTurn, TurnBasedMultiplayerManager::FinishDuringMyTurn e outras funções relacionadas. Sempre use ParticipantResults().WithResult(...) para criar um novo objeto ParticipantResults consistente com os objetos existentes. Valid precisa retornar verdadeiro 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 verdadeiro para que essa função seja utilizável.

PendingParticipant

MultiplayerParticipant PendingParticipant() const

Retorna o participante que tem a vez de atualizar essa correspondência.

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

PreviousMatchData

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

Dados da partida anterior, se HasPreviousMatchData().

Só pode ser chamado se Valid retornar verdadeiro.

RematchId

const std::string & RematchId() const

Retorna o ID da partida que é uma revanche, 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 verdadeiro 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 conectados, que podem ser convidados e que fazem correspondência automática.

Se essa função for sempre usada para selecionar o próximo participante, o jogo vai passar por todos os participantes na ordem, repetindo se necessário. Essa função só precisa ser chamada se Status() for MatchStatus::MY_TURN, porque esse é o único momento em que o resultado dessa função pode ser usado de forma significativa. Se for chamada incorretamente, essa função vai 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 a 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 o TurnBasedMatch for preenchido com dados.

Precisa retornar "true" para que as funções getter no objeto TurnBasedMatch (Id, CreationTime etc.) sejam utilizáveis.

Variante

uint32_t Variant() const

Retorna um identificador de variante específico do jogo que pode ser usado para identificar diferentes modos de jogo.

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

Versão

uint32_t Version() const

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

operator=

TurnBasedMatch & operator=(
  const TurnBasedMatch & copy_from
)

Atribui essa TurnBasedMatch copiando de outra.

operator=

TurnBasedMatch & operator=(
  TurnBasedMatch && move_from
)

Atribui este TurnBasedMatch movendo outro para ele.