gpg:: RealTimeRoom
#include <real_time_room.h>
Uma estrutura de dados que contém o estado atual de uma sala multiplayer em tempo real.
Resumo
Construtores e destruidores |
|
---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
Cria uma cópia de um objeto
RealTimeRoom atual. |
|
RealTimeRoom(RealTimeRoom && move_from)
Move um objeto
RealTimeRoom existente. |
Funções públicas |
|
---|---|
AutomatchWaitEstimate() const
|
Uma estimativa gerada pelo servidor do tempo que levará para preencher os espaços com correspondência automática da sala.
|
CreatingParticipant() const
|
Retorna o participante que criou esta sala.
|
CreationTime() const
|
std::chrono::milliseconds
Retorna o horário em que esse objeto
RealTimeRoom foi criado (expresso em milissegundos desde a época do Unix). |
Description() const
|
std::string
Retorna um resumo do estado da sala gerado pelo servidor.
|
Id() const
|
const std::string &
Retorna um ID que identifica exclusivamente este objeto
RealTimeRoom . |
Participants() const
|
std::vector< MultiplayerParticipant >
Vetor de todos os participantes desta sala.
|
RemainingAutomatchingSlots() const
|
uint32_t
Retorna o número de espaços disponíveis com correspondência automática para a sala.
|
Status() const
|
Retorna o status da sala.
|
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 por um jogo 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 levará para preencher os espaços com correspondência automática da sala.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Retorna o participante que criou esta sala.
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 objeto RealTimeRoom
foi criado (expresso em milissegundos desde a época do Unix).
Valid precisa retornar "true" para que essa função seja utilizável.
Descrição
std::string Description() const
Retorna um resumo do estado da sala gerado pelo servidor.
Valid precisa retornar "true" para que essa função seja utilizável.
ID
const std::string & Id() const
Retorna um ID que identifica exclusivamente este objeto RealTimeRoom
.
Para recuperar esta sala em um momento posterior, use este ID com RealTimeRoom::FetchRoom
.
Valid precisa retornar "true" para que essa função seja utilizável.
Participantes
std::vector< MultiplayerParticipant > Participants() const
Vetor de todos os participantes desta sala.
Valid precisa retornar "true" para que essa função seja utilizável.
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
Cria um objeto RealTimeRoom
de uma shared_ptr
para um objeto RealTimeRoomImpl
.
Destinado ao uso interno pela API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Cria uma cópia de um objeto RealTimeRoom
atual.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Retorna o número de espaços disponíveis com correspondência automática para a sala.
Esse número é igual ao número de espaços com correspondência automática com que a sala 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.
Status
RealTimeRoomStatus Status() const
Retorna o status da sala.
O status determina as ações que podem ser realizadas em uma sala. Valid precisa retornar "true" 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.) 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.
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.