гпг:: RealTimeКомната

#include <real_time_room.h>

Структура данных, содержащая текущее состояние многопользовательской комнаты в реальном времени.

Краткое содержание

Конструкторы и деструкторы

RealTimeRoom ()
RealTimeRoom (std::shared_ptr< const RealTimeRoomImpl > impl)
Конструирует объект RealTimeRoom из shared_ptr в объект RealTimeRoomImpl .
RealTimeRoom (const RealTimeRoom & copy_from)
Создает копию существующего объекта RealTimeRoom .
RealTimeRoom ( RealTimeRoom && move_from)
Перемещает существующий объект RealTimeRoom .

Общественные функции

AutomatchWaitEstimate () const
Сгенерированная сервером оценка времени, которое потребуется для заполнения автоматически подходящих слотов в этой комнате.
CreatingParticipant () const
Возвращает участника, создавшего эту комнату.
CreationTime () const
std::chrono::milliseconds
Возвращает время создания объекта RealTimeRoom (выраженное в миллисекундах с эпохи Unix).
Description () const
std::string
Возвращает сгенерированную сервером сводку о состоянии комнаты.
Id () const
const std::string &
Возвращает идентификатор, который уникально идентифицирует этот объект RealTimeRoom .
Participants () const
std::vector< MultiplayerParticipant >
Вектор всех участников в этой комнате.
RemainingAutomatchingSlots () const
uint32_t
Возвращает количество доступных автоматически подходящих слотов для комнаты.
Status () const
Возвращает статус комнаты.
Valid () const
bool
Возвращает true, если этот объект RealTimeRoom заполнен данными.
Variant () const
uint32_t
Возвращает идентификатор варианта игры, который может использоваться игрой для идентификации различных игровых режимов.
operator= (const RealTimeRoom & copy_from)
Назначает этот объект RealTimeRoom путем копирования из другого.
operator= ( RealTimeRoom && move_from)
Назначает этот объект RealTimeRoom , перемещая в него другой объект.

Общественные функции

АвтосопоставлениеWaitОценка

Timeout AutomatchWaitEstimate() const

Сгенерированная сервером оценка времени, которое потребуется для заполнения автоматически подходящих слотов в этой комнате.

Создание участника

MultiplayerParticipant CreatingParticipant() const

Возвращает участника, создавшего эту комнату.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

время создания

std::chrono::milliseconds CreationTime() const

Возвращает время создания объекта RealTimeRoom (выраженное в миллисекундах с эпохи Unix).

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Описание

std::string Description() const

Возвращает сгенерированную сервером сводку о состоянии комнаты.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Идентификатор

const std::string & Id() const

Возвращает идентификатор, который уникально идентифицирует этот объект RealTimeRoom .

Чтобы получить эту комнату позже, используйте этот идентификатор с RealTimeRoom::FetchRoom .

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Участники

std::vector< MultiplayerParticipant > Participants() const

Вектор всех участников в этой комнате.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

RealTimeКомната

 RealTimeRoom()

RealTimeКомната

 RealTimeRoom(
  std::shared_ptr< const RealTimeRoomImpl > impl
)

Конструирует объект RealTimeRoom из shared_ptr в объект RealTimeRoomImpl .

Предназначен для внутреннего использования API.

RealTimeКомната

 RealTimeRoom(
  const RealTimeRoom & copy_from
)

Создает копию существующего объекта RealTimeRoom .

RealTimeКомната

 RealTimeRoom(
  RealTimeRoom && move_from
)

Перемещает существующий объект RealTimeRoom .

Оставшиеся слоты для автоматического сопоставления

uint32_t RemainingAutomatchingSlots() const

Возвращает количество доступных автоматически подходящих слотов для комнаты.

Это число равно количеству слотов автоматического сопоставления, с которыми была создана комната, за вычетом количества участников, которые уже были добавлены посредством автоматического сопоставления. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Положение дел

RealTimeRoomStatus Status() const

Возвращает статус комнаты.

Статус определяет, какие действия можно предпринять в комнате. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Действительный

bool Valid() const

Возвращает true, если этот объект RealTimeRoom заполнен данными.

Должен возвращать true, чтобы функции получения объекта RealTimeRoom ( Id , CreationTime и т. д.) могли быть использованы.

Вариант

uint32_t Variant() const

Возвращает идентификатор варианта игры, который может использоваться игрой для идентификации различных игровых режимов.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

оператор=

RealTimeRoom & operator=(
  const RealTimeRoom & copy_from
)

Назначает этот объект RealTimeRoom путем копирования из другого.

оператор=

RealTimeRoom & operator=(
  RealTimeRoom && move_from
)

Назначает этот объект RealTimeRoom , перемещая в него другой объект.