gpg:: RealTimeRoom
#include <real_time_room.h>
Uma estrutura de dados que contém o estado atual de uma sala multijogador em tempo real.
Resumo
Construtores e destrutores |
|
---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
Cria uma cópia de um objeto
RealTimeRoom . |
|
RealTimeRoom(RealTimeRoom && move_from)
Move um objeto
RealTimeRoom . |
Funções públicas |
|
---|---|
AutomatchWaitEstimate() const
|
Uma estimativa gerada pelo servidor do tempo que será necessário para preencher os slots de correspondência automática da sala.
|
CreatingParticipant() const
|
Retorna o participante que criou a sala.
|
CreationTime() const
|
std::chrono::milliseconds
Retorna o horário em que o objeto
RealTimeRoom foi criado (expresso em milissegundos desde a época Unix). |
Description() const
|
std::string
Retorna um resumo gerado pelo servidor do estado do ambiente.
|
Id() const
|
const std::string &
Retorna um ID que identifica de maneira exclusiva esse objeto
RealTimeRoom . |
Participants() const
|
std::vector< MultiplayerParticipant >
Um vetor de todos os participantes na sala.
|
RemainingAutomatchingSlots() const
|
uint32_t
Retorna o número de slots de correspondência automática disponíveis para o ambiente.
|
Status() const
|
Retorna o status do ambiente.
|
Valid() const
|
bool
Retorna verdadeiro se esse objeto
RealTimeRoom 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.
|
operator=(const RealTimeRoom & copy_from)
|
Atribui esse objeto
RealTimeRoom copiando de outro. |
operator=(RealTimeRoom && move_from)
|
Atribui esse objeto
RealTimeRoom movendo outro para ele. |
Funções públicas
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
Uma estimativa gerada pelo servidor do tempo que será necessário para preencher os slots de correspondência automática da sala.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Retorna o participante que criou a sala.
Valid precisa retornar verdadeiro para que essa função seja utilizável.
CreationTime
std::chrono::milliseconds CreationTime() const
Retorna o horário em que o objeto RealTimeRoom
foi criado (expresso em milissegundos desde a época Unix).
Valid precisa retornar verdadeiro para que essa função seja utilizável.
Descrição
std::string Description() const
Retorna um resumo gerado pelo servidor do estado do ambiente.
Valid precisa retornar verdadeiro para que essa função seja utilizável.
ID
const std::string & Id() const
Retorna um ID que identifica de forma exclusiva esse objeto RealTimeRoom
.
Para recuperar essa sala mais tarde, use esse ID com RealTimeRoom::FetchRoom
.
Valid precisa retornar verdadeiro para que essa função seja utilizável.
Participantes
std::vector< MultiplayerParticipant > Participants() const
Um vetor de todos os participantes na sala.
Valid precisa retornar verdadeiro para que essa função seja utilizável.
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
Cria um objeto RealTimeRoom
de um shared_ptr
para um objeto RealTimeRoomImpl
.
Destinado a uso interno pela API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Cria uma cópia de um objeto RealTimeRoom
.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Retorna o número de slots de correspondência automática disponíveis para a sala.
Esse número é igual ao número de slots de correspondência automática com que a sala 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.
Status
RealTimeRoomStatus Status() const
Retorna o status do quarto.
O status determina quais ações podem ser realizadas em uma sala. Valid precisa retornar verdadeiro para que essa função seja utilizável.
Válido
bool Valid() const
Retorna verdadeiro se esse objeto RealTimeRoom
for preenchido com dados.
Precisa retornar "true" para que as funções getter no objeto RealTimeRoom
(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.
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
Atribui esse objeto RealTimeRoom
copiando de outro.
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
Atribui esse objeto RealTimeRoom
movendo outro para ele.