гпг:: МультиплеерПриглашение

#include <multiplayer_invitation.h>

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

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

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

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

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

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

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

Автоматическое сопоставление слотовДоступно

uint32_t AutomatchingSlotsAvailable() const

Возвращает количество доступных слотов автоматического соответствия для совпадения, для которого этот объект является приглашением.

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

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

Timestamp CreationTime() const

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

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

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

const std::string & Id() const

Возвращает идентификатор, который однозначно идентифицирует этот MultiplayerInvitation .

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

Приглашающий Участник

MultiplayerParticipant InvitingParticipant() const

Возвращает участника, который пригласил локального участника в TurnBasedMatch для этого приглашения.

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

МультиплеерПриглашение 

 MultiplayerInvitation()

МультиплеерПриглашение

 MultiplayerInvitation(
  std::shared_ptr< const TurnBasedMatchImpl > impl
)

Создает MultiplayerInvitation из shared_ptr в TurnBasedMatchImpl .

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

МультиплеерПриглашение

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

Создает MultiplayerInvitation из shared_ptr в RealTimeRoomImpl .

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

МультиплеерПриглашение

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

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

МультиплеерПриглашение

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

Перемещает существующее MultiplayerInvitation в новое.

Участники

const std::vector< MultiplayerParticipant > & Participants() const

Вектор всех участников TurnBasedMatch для этого приглашения.

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

Тип

MultiplayerInvitationType Type() const

Определяет, предназначено ли это приглашение для RealTimeRoom или TurnBasedMatch .

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

bool Valid() const

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

Должно быть истинно, чтобы можно было использовать функции получения ( Id , Variant и т. д.) для этого объекта MultiplayerInvitation .

Вариант

uint32_t Variant() const

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

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

оператор=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

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

оператор=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

Назначает это MultiplayerInvitation , перемещая в него другое.