гпг:: RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

Извлекает, изменяет, обрабатывает сообщения и создает объекты RealTimeRoom .

Резюме

Общедоступные типы

FetchInvitationsCallback определение типа
std::function< void(const FetchInvitationsResponse &)>
Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.
LeaveRoomCallback определение типа
std::function< void(const ResponseStatus &)>
Определяет обратный вызов, который может получить ResponseStatus от LeaveRoom .
PlayerSelectUICallback определение типа
std::function< void(const PlayerSelectUIResponse &)>
Определяет обратный вызов, который может получить PlayerSelectUIResponse от ShowPlayerSelectUI .
PlayerSelectUIResponse определение типа
Data и ResponseStatus для операции ShowPlayerSelectUI .
RealTimeRoomCallback определение типа
std::function< void(const RealTimeRoomResponse &)>
Определяет обратный вызов, который можно использовать для получения структуры RealTimeRoomResponse от одной из пошаговых многопользовательских операций.
RoomInboxUICallback определение типа
std::function< void(const RoomInboxUIResponse &)>
Определяет обратный вызов, который может получить RoomInboxUIResponse от ShowRoomInboxUI .
SendReliableMessageCallback определение типа
std::function< void(const MultiplayerStatus &)>
Определяет обратный вызов, который может получить ResponseStatus от SendReliableMessage .
WaitingRoomUICallback определение типа
std::function< void(const WaitingRoomUIResponse &)>
Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.

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

AcceptInvitation (const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
Асинхронно принимает MultiplayerInvitation и возвращает результат через RealTimeRoomCallback .
AcceptInvitation (const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
Асинхронно принимает MultiplayerInvitation и возвращает результат через RealTimeRoomCallback .
AcceptInvitationBlocking ( Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
Блокирующая версия AcceptInvitation .
AcceptInvitationBlocking (const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
Перегрузка AcceptInvitationBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
AcceptInvitationBlocking ( Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Блокирующая версия AcceptInvitation .
AcceptInvitationBlocking (const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Перегрузка AcceptInvitationBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
CreateRealTimeRoom (const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .
CreateRealTimeRoom (const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .
CreateRealTimeRoomBlocking ( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Блокирующая версия CreateRealTimeRoom .
CreateRealTimeRoomBlocking (const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Перегрузка CreateRealTimeRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
CreateRealTimeRoomBlocking ( Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Блокирующая версия CreateRealTimeRoom .
CreateRealTimeRoomBlocking (const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Перегрузка CreateRealTimeRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
DeclineInvitation (const MultiplayerInvitation & invitation)
void
Отклоняет MultiplayerInvitation в RealTimeRoom .
DismissInvitation (const MultiplayerInvitation & invitation)
void
Отклоняет MultiplayerInvitation в RealTimeRoom .
FetchInvitations ( FetchInvitationsCallback callback)
void
Получает любые MultiplayerInvitation для комнат в реальном времени.
FetchInvitationsBlocking ( Timeout timeout)
Блокирующая версия FetchInvitations .
FetchInvitationsBlocking ()
Перегрузка FetchInvitationsBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
LeaveRoom (const RealTimeRoom & room, LeaveRoomCallback callback)
void
Оставляет RealTimeRoom .
LeaveRoomBlocking ( Timeout timeout, const RealTimeRoom & room)
Блокирующая версия LeaveRoom .
LeaveRoomBlocking (const RealTimeRoom & room)
Перегрузка LeaveRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
SendReliableMessage (const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)
void
Отправляет сообщение указанному MultiplayerParticipant .
SendReliableMessageBlocking ( Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
Блокирующая версия SendReliableMessage .
SendReliableMessageBlocking (const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
Перегрузка SendReliableMessageBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
SendUnreliableMessage (const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
void
Отправляет сообщение указанным MultiplayerParticipant s.
SendUnreliableMessageToOthers (const RealTimeRoom & room, std::vector< uint8_t > data)
void
Отправляет сообщение всем участникам, кроме текущего пользователя.
ShowPlayerSelectUI (uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
void
Асинхронно показывает интерфейс выбора игрока, позволяя игроку выбирать других игроков, чтобы присоединиться к комнате.
ShowPlayerSelectUIBlocking ( Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
Блокирующая версия ShowPlayerSelectUI .
ShowPlayerSelectUIBlocking (uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
Перегрузка ShowPlayerSelectUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.
ShowRoomInboxUI ( RoomInboxUICallback callback)
void
Асинхронно показывает пользовательский интерфейс входящих сообщений комнаты, позволяя игроку выбрать многопользовательское приглашение.
ShowRoomInboxUIBlocking ( Timeout timeout)
Блокирующая версия ShowRoomInboxUI .
ShowRoomInboxUIBlocking ()
Перегрузка ShowRoomInboxUIBlocking , которая использует время ожидания по умолчанию, равное 10 годам.
ShowWaitingRoomUI (const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
void
Показывает пользовательский интерфейс комнаты ожидания, в котором отображается статус участников многопользовательской игры, присоединяющихся к этой комнате.
ShowWaitingRoomUIBlocking ( Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
Блокирующая версия ShowWaitingRoomUI .
ShowWaitingRoomUIBlocking (const RealTimeRoom & room, uint32_t min_participants_to_start)
Перегрузка ShowWaitingRoomUIBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

Структуры

gpg::RealTimeMultiplayerManager::FetchInvitationsResponse

Data и ResponseStatus для операции FetchInvitations .

gpg::RealTimeMultiplayerManager::RealTimeRoomResponse

Data и ResponseStatus для конкретного объекта RealTimeRoom .

gpg:: RealTimeMultiplayerManager:: RoomInboxUIResponse

Data и ResponseStatus для операции ShowRoomInboxUI .

gpg::RealTimeMultiplayerManager::WaitingRoomUIResponse

Data и ResponseStatus для операции ShowWaitingRoomUI .

Общедоступные типы

Обратный вызов

std::function< void(const FetchInvitationsResponse &)> FetchInvitationsCallback

Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.

Обратный звонок

std::function< void(const ResponseStatus &)> LeaveRoomCallback

Определяет обратный вызов, который может получить ResponseStatus от LeaveRoom .

PlayerSelectUICallback

std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback

Определяет обратный вызов, который может получить PlayerSelectUIResponse от ShowPlayerSelectUI .

PlayerSelectUIResponse

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

Data и ResponseStatus для операции ShowPlayerSelectUI .

Это совместно с пошаговым многопользовательским режимом.

Обратный вызов RealTimeRoom

std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback

Определяет обратный вызов, который можно использовать для получения структуры RealTimeRoomResponse от одной из пошаговых многопользовательских операций.

RoomInboxUICallback

std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback

Определяет обратный вызов, который может получить RoomInboxUIResponse от ShowRoomInboxUI .

SendReliableMessageCallback

std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback

Определяет обратный вызов, который может получить ResponseStatus от SendReliableMessage .

WaitingRoomUICallback

std::function< void(const WaitingRoomUIResponse &)> WaitingRoomUICallback

Определяет обратный вызов, который можно использовать для получения WaitingRoomUIResponse от одной из многопользовательских операций в реальном времени.

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

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

void AcceptInvitation(
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener,
  RealTimeRoomCallback callback
)

Асинхронно принимает MultiplayerInvitation и возвращает результат через RealTimeRoomCallback .

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

void AcceptInvitation(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper,
  RealTimeRoomCallback callback
)

Асинхронно принимает MultiplayerInvitation и возвращает результат через RealTimeRoomCallback .

АкцептИнвитатионБлокинг

RealTimeRoomResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener
)

Блокирующая версия AcceptInvitation .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

АкцептИнвитатионБлокинг

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener
)

Перегрузка AcceptInvitationBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

АкцептИнвитатионБлокинг

RealTimeRoomResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

Блокирующая версия AcceptInvitation .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

АкцептИнвитатионБлокинг

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

Перегрузка AcceptInvitationBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

Создать RealTimeRoom

void CreateRealTimeRoom(
  const gpg::RealTimeRoomConfig & config,
  IRealTimeEventListener *listener,
  RealTimeRoomCallback callback
)

Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .

Если создание прошло успешно, эта функция возвращает объект RealTimeRoom через предоставленный RealTimeRoomCallback .

Создать RealTimeRoom

void CreateRealTimeRoom(
  const gpg::RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper,
  RealTimeRoomCallback callback
)

Асинхронно создает объект RealTimeRoom используя предоставленный класс RealTimeRoomConfig .

Если создание прошло успешно, эта функция возвращает объект RealTimeRoom через предоставленный RealTimeRoomCallback .

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  Timeout timeout,
  const RealTimeRoomConfig & config,
  IRealTimeEventListener *listener
)

Блокирующая версия CreateRealTimeRoom .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  IRealTimeEventListener *listener
)

Перегрузка CreateRealTimeRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  Timeout timeout,
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

Блокирующая версия CreateRealTimeRoom .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

Перегрузка CreateRealTimeRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

Отклонить приглашение

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

Отклоняет MultiplayerInvitation в RealTimeRoom .

Это отменяет доступ к комнате для других участников и удаляет комнату с устройства локального игрока.

Отклонить приглашение

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

Отклоняет MultiplayerInvitation в RealTimeRoom .

Это не изменяет видимое состояние RealTimeRoom для других участников, но удаляет его с устройства локального игрока.

FetchInvitations

void FetchInvitations(
  FetchInvitationsCallback callback
)

Получает любые MultiplayerInvitation для комнат в реальном времени.

Полученные MultiplayerInvitation возвращаются через предоставленный FetchInvitationsCallback .

FetchInvitationsБлокировка

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

Блокирующая версия FetchInvitations .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция вернет ERROR_TIMEOUT .

FetchInvitationsБлокировка

FetchInvitationsResponse FetchInvitationsBlocking()

Перегрузка FetchInvitationsBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

Покинуть комнату

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

Оставляет RealTimeRoom .

Вы не должны создавать новую комнату или пытаться присоединиться к другой комнате, пока эта операция не будет завершена. Результат этой операции возвращается через LeaveRoomCallback .

Выйти из RoomBlocking

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

Блокирующая версия LeaveRoom .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

Выйти из RoomBlocking

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

Перегрузка LeaveRoomBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

ОтправитьНадежноеСообщение

void SendReliableMessage(
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data,
  SendReliableMessageCallback callback
)

Отправляет сообщение указанному MultiplayerParticipant .

Использует надежный метод для отправки сообщения. Этот метод отправки данных может занять больше времени, чем ненадежная отправка сообщения. Результат отправки сообщается через предоставленный обратный вызов.

Сендрелаблемессажеблокинг

MultiplayerStatus SendReliableMessageBlocking(
  Timeout timeout,
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data
)

Блокирующая версия SendReliableMessage .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

Сендрелаблемессажеблокинг

MultiplayerStatus SendReliableMessageBlocking(
  const RealTimeRoom & room,
  const MultiplayerParticipant & participant,
  std::vector< uint8_t > data
)

Перегрузка SendReliableMessageBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

SendUnreliableMessage

void SendUnreliableMessage(
  const RealTimeRoom & room,
  const std::vector< MultiplayerParticipant > & participants,
  std::vector< uint8_t > data
)

Отправляет сообщение указанным MultiplayerParticipant s.

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

Сендунрелаблемессажетотерс

void SendUnreliableMessageToOthers(
  const RealTimeRoom & room,
  std::vector< uint8_t > data
)

Отправляет сообщение всем участникам, кроме текущего пользователя.

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

ShowPlayerSelectUI

void ShowPlayerSelectUI(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch,
  PlayerSelectUICallback callback
)

Асинхронно показывает интерфейс выбора игрока, позволяя игроку выбирать других игроков, чтобы присоединиться к комнате.

По завершении выбранные игроки будут возвращены через PlayerSelectUICallback .

ShowPlayerSelectUIBlocking

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  Timeout timeout,
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

Блокирующая версия ShowPlayerSelectUI .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

ShowPlayerSelectUIBlocking

PlayerSelectUIResponse ShowPlayerSelectUIBlocking(
  uint32_t minimum_players,
  uint32_t maximum_players,
  bool allow_automatch
)

Перегрузка ShowPlayerSelectUIBlocking , которая использует тайм-аут по умолчанию, равный 10 годам.

ShowRoomInboxUI

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

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

По завершении выбранное приглашение возвращается через RoomInboxUIResponse .

ШоумИнбоксUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

Блокирующая версия ShowRoomInboxUI .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция возвращает ERROR_TIMEOUT .

ШоумИнбоксUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking()

Перегрузка ShowRoomInboxUIBlocking , которая использует время ожидания по умолчанию, равное 10 годам.

ПоказатьWaitingRoomUI

void ShowWaitingRoomUI(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start,
  WaitingRoomUICallback callback
)

Показывает пользовательский интерфейс комнаты ожидания, в котором отображается статус участников многопользовательской игры, присоединившихся к этой комнате.

ShowWaitingRoomUIBlocking

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  Timeout timeout,
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

Блокирующая версия ShowWaitingRoomUI .

Позволяет вызывающей стороне указать время ожидания в мс. По истечении указанного времени функция вернет ERROR_TIMEOUT .

ShowWaitingRoomUIBlocking

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

Перегрузка ShowWaitingRoomUIBlocking , которая использует время ожидания по умолчанию, равное 10 годам.