gpg:: RealTimeRoom
#include <real_time_room.h>
Uma estrutura de dados contendo o estado atual de uma sala multiplayer 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 existente. |
|
RealTimeRoom(RealTimeRoom && move_from)
Move um objeto
RealTimeRoom já existente. |
Funções públicas |
|
---|---|
AutomatchWaitEstimate() const
|
Uma estimativa gerada pelo servidor do tempo necessário para preencher os horários de correspondência automática desta sala.
|
CreatingParticipant() const
|
Retorna o participante que criou a sala.
|
CreationTime() const
|
std::chrono::milliseconds
Retorna o momento em que esse objeto
RealTimeRoom foi criado, expresso em milissegundos desde a época 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 esse objeto
RealTimeRoom . |
Participants() const
|
std::vector< MultiplayerParticipant >
Um vetor de todos os participantes nesta sala.
|
RemainingAutomatchingSlots() const
|
uint32_t
Retorna o número de horários de correspondência automática disponíveis 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 para identificar diferentes modos.
|
operator=(const RealTimeRoom & copy_from)
|
Atribui este objeto
RealTimeRoom copiando de outro. |
operator=(RealTimeRoom && move_from)
|
Atribui este objeto
RealTimeRoom movendo outro para dentro dele. |
Funções públicas
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
Uma estimativa gerada pelo servidor do tempo necessário para preencher os horários de correspondência automática desta sala.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Retorna o participante que criou a sala.
Valid precisa retornar true para que essa função seja utilizável.
CreationTime
std::chrono::milliseconds CreationTime() const
Retorna o momento em que esse objeto RealTimeRoom
foi criado, expresso em milissegundos desde a época 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 esse objeto RealTimeRoom
.
Para recuperar esta sala mais tarde, use o ID com RealTimeRoom::FetchRoom
.
Valid precisa retornar true para que essa função seja utilizável.
Participantes
std::vector< MultiplayerParticipant > Participants() const
Um vetor de todos os participantes nesta 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 um shared_ptr
para um objeto RealTimeRoomImpl
.
Destinado ao uso interno da API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Cria uma cópia de um objeto RealTimeRoom
existente.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Retorna o número de horários de correspondência automática disponíveis para a sala.
Esse número é igual ao número de horários correspondentes automáticos em 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álida
bool Valid() const
Retorna verdadeiro se esse objeto RealTimeRoom
for preenchido com dados.
Precisa retornar verdadeiro 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 para identificar diferentes modos.
Valid precisa retornar true para que essa função seja utilizável.
operador=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
Atribui este objeto RealTimeRoom
copiando de outro.
operador=
RealTimeRoom & operator=( RealTimeRoom && move_from )
Atribui este objeto RealTimeRoom
movendo outro para dentro dele.