gpg::RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

RealTimeRoom オブジェクトの取得、変更、メッセージ処理、作成を行います。

概要

パブリック タイプ
FetchInvitationsCallback typedef
std::function< void(const FetchInvitationsResponse &)>
リアルタイム マルチプレイヤー オペレーションのいずれかから WaitingRoomUIResponse を受信するために使用できるコールバックを定義します。
LeaveRoomCallback typedef
std::function< void(const ResponseStatus &)>
LeaveRoom から ResponseStatus を受信できるコールバックを定義します。
PlayerSelectUICallback typedef
std::function< void(const PlayerSelectUIResponse &)>
ShowPlayerSelectUI から PlayerSelectUIResponse を受信できるコールバックを定義します。
PlayerSelectUIResponse typedef
ShowPlayerSelectUI オペレーションの Data と ResponseStatus。
RealTimeRoomCallback typedef
std::function< void(const RealTimeRoomResponse &)>
ターン制マルチプレイヤー オペレーションのいずれかから RealTimeRoomResponse 構造体を受け取るために使用できるコールバックを定義します。
RoomInboxUICallback typedef
std::function< void(const RoomInboxUIResponse &)>
ShowRoomInboxUI から RoomInboxUIResponse を受信できるコールバックを定義します。
SendReliableMessageCallback typedef
std::function< void(const MultiplayerStatus &)>
SendReliableMessage から ResponseStatus を受信できるコールバックを定義します。
WaitingRoomUICallback typedef
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)
デフォルトのタイムアウトが 10 年になる AcceptInvitationBlocking のオーバーロード。
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
AcceptInvitation のブロック バージョン。
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
デフォルトのタイムアウトが 10 年になる AcceptInvitationBlocking のオーバーロード。
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
指定された RealTimeRoomConfig クラスを使用して、RealTimeRoom オブジェクトを非同期で作成します。
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
指定された RealTimeRoomConfig クラスを使用して、RealTimeRoom オブジェクトを非同期で作成します。
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
CreateRealTimeRoom のブロック バージョン。
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
デフォルトのタイムアウトが 10 年になる CreateRealTimeRoomBlocking のオーバーロード。
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
CreateRealTimeRoom のブロック バージョン。
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
デフォルトのタイムアウトが 10 年になる CreateRealTimeRoomBlocking のオーバーロード。
DeclineInvitation(const MultiplayerInvitation & invitation)
void
MultiplayerInvitation を RealTimeRoom に拒否します。
DismissInvitation(const MultiplayerInvitation & invitation)
void
MultiplayerInvitation を RealTimeRoom に閉じます。
FetchInvitations(FetchInvitationsCallback callback)
void
リアルタイム ルームの MultiplayerInvitation を取得します。
FetchInvitationsBlocking(Timeout timeout)
FetchInvitations のブロック バージョン。
FetchInvitationsBlocking()
デフォルトのタイムアウトが 10 年になる FetchInvitationsBlocking のオーバーロード。
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)
void
RealTimeRoom を残します。
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)
LeaveRoom のブロック バージョン。
LeaveRoomBlocking(const RealTimeRoom & room)
デフォルトのタイムアウトが 10 年になる LeaveRoomBlocking のオーバーロード。
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)
デフォルトのタイムアウトが 10 年になる SendReliableMessageBlocking のオーバーロード。
SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
void
指定された MultiplayerParticipant にメッセージを送信します。
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
プレーヤー選択 UI を非同期で表示し、プレーヤーが部屋に参加する他のプレーヤーを選択できるようにします。
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)
デフォルトのタイムアウトが 10 年になる ShowPlayerSelectUIBlocking のオーバーロード。
ShowRoomInboxUI(RoomInboxUICallback callback)
void
部屋の受信トレイ UI を非同期で表示し、プレーヤーがマルチプレーヤー招待を選択できるようにします。
ShowRoomInboxUIBlocking(Timeout timeout)
ShowRoomInboxUI のブロック バージョン。
ShowRoomInboxUIBlocking()
デフォルトのタイムアウトが 10 年のデフォルトの ShowRoomInboxUIBlocking のオーバーロード。
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
void
この部屋に参加する MultiplayerParticipants のステータスを表示する待機室 UI が表示されます。
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
ShowWaitingRoomUI のブロック バージョン。
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)
デフォルトのタイムアウトが 10 年になる ShowWaitingRoomUIBlocking のオーバーロード。

構造体
gpg::RealTimeMultiplayerManager::FetchInvitationsResponse

FetchInvitations オペレーションの Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::RealTimeRoomResponse

特定の RealTimeRoom オブジェクトの Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::RoomInboxUIResponse

ShowRoomInboxUI オペレーションの Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::WaitingRoomUIResponse

ShowWaitingRoomUI オペレーションの Data と ResponseStatus。

パブリック タイプ

FetchInvitationsCallback

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

リアルタイム マルチプレイヤー オペレーションのいずれかから WaitingRoomUIResponse を受信するために使用できるコールバックを定義します。

LeaveRoomCallback

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

LeaveRoom から ResponseStatus を受信できるコールバックを定義します。

PlayerSelectUICallback

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

ShowPlayerSelectUI から PlayerSelectUIResponse を受信できるコールバックを定義します。

PlayerSelectUIResponse

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

ShowPlayerSelectUI オペレーションの Data と ResponseStatus。

これはターン制マルチプレーヤーと共有されます。

RealTimeRoomCallback

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

ターン制マルチプレイヤー オペレーションのいずれかから RealTimeRoomResponse 構造体を受け取るために使用できるコールバックを定義します。

RoomInboxUICallback

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

ShowRoomInboxUI から RoomInboxUIResponse を受信できるコールバックを定義します。

SendReliableMessageCallback

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

SendReliableMessage から ResponseStatus を受信できるコールバックを定義します。

WaitingRoomUICallback

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

リアルタイム マルチプレイヤー オペレーションのいずれかから WaitingRoomUIResponse を受信するために使用できるコールバックを定義します。

パブリック関数

AcceptInvitation

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

MultiplayerInvitation を非同期で受け入れ、RealTimeRoomCallback を介して結果を返します。

AcceptInvitation

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

MultiplayerInvitation を非同期で受け入れ、RealTimeRoomCallback を介して結果を返します。

AcceptInvitationBlocking

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

AcceptInvitation のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

AcceptInvitationBlocking

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

デフォルトのタイムアウトが 10 年になる AcceptInvitationBlocking のオーバーロード。

AcceptInvitationBlocking

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

AcceptInvitation のブロック バージョン。

呼び出し元がミリ秒単位のタイムアウトを指定できるようにします。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

AcceptInvitationBlocking

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

デフォルトのタイムアウトが 10 年になる AcceptInvitationBlocking のオーバーロード。

CreateRealTimeRoom

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

指定された RealTimeRoomConfig クラスを使用して、RealTimeRoom オブジェクトを非同期で作成します。

作成が成功すると、この関数は指定された RealTimeRoomCallback を介して RealTimeRoom オブジェクトを返します。

CreateRealTimeRoom

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

指定された RealTimeRoomConfig クラスを使用して、RealTimeRoom オブジェクトを非同期で作成します。

作成が成功すると、この関数は指定された RealTimeRoomCallback を介して RealTimeRoom オブジェクトを返します。

CreateRealTimeRoomBlocking

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

CreateRealTimeRoom のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

CreateRealTimeRoomBlocking

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

デフォルトのタイムアウトが 10 年になる CreateRealTimeRoomBlocking のオーバーロード。

CreateRealTimeRoomBlocking

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

CreateRealTimeRoom のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

デフォルトのタイムアウトが 10 年になる CreateRealTimeRoomBlocking のオーバーロード。

DeclineInvitation

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

MultiplayerInvitation を RealTimeRoom に拒否します。

これにより、他の参加者の部屋が解散され、ローカル プレーヤーのデバイスから部屋が削除されます。

DismissInvitation

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

MultiplayerInvitation を RealTimeRoom に閉じます。

これにより、他の参加者に対して RealTimeRoom の表示状態は変更されませんが、ローカル プレーヤーのデバイスから削除されます。

FetchInvitations

void FetchInvitations(
  FetchInvitationsCallback callback
)

リアルタイム ルームの MultiplayerInvitation を取得します。

フェッチされた MultiplayerInvitation は、指定された FetchInvitationsCallback を介して返されます。

FetchInvitationsBlocking

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

FetchInvitations のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

FetchInvitationsBlocking

FetchInvitationsResponse FetchInvitationsBlocking()

デフォルトのタイムアウトが 10 年になる FetchInvitationsBlocking のオーバーロード。

LeaveRoom

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

RealTimeRoom を残します。

このオペレーションが完了するまで、新しいルームを作成したり、別のルームに参加したりするべきではありません。このオペレーションの結果は LeaveRoomCallback を介して返されます。

LeaveRoomBlocking

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

LeaveRoom のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

LeaveRoomBlocking

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

デフォルトのタイムアウトが 10 年になる LeaveRoomBlocking のオーバーロード。

SendReliableMessage

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

指定された MultiplayerParticipant にメッセージを送信します。

信頼できる方法でメッセージを送信します。この方法でデータを送信すると、信頼できないメッセージを送信するよりも時間がかかる場合があります。送信の結果は、指定されたコールバックを介して報告されます。

SendReliableMessageBlocking

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

SendReliableMessage のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

SendReliableMessageBlocking

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

デフォルトのタイムアウトが 10 年になる SendReliableMessageBlocking のオーバーロード。

SendUnreliableMessage

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

指定された MultiplayerParticipant にメッセージを送信します。

信頼できない方法でメッセージを送信します。このデータ送信方法は、信頼性の高いデータ送信よりも高速であるため、可能であればこの方法を優先する必要があります。

SendUnreliableMessageToOthers

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
)

プレーヤー選択 UI を非同期で表示し、プレーヤーが部屋に参加する他のプレーヤーを選択できるようにします。

完了すると、選択したプレーヤーが 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
)

デフォルトのタイムアウトが 10 年になる ShowPlayerSelectUIBlocking のオーバーロード。

ShowRoomInboxUI

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

部屋の受信トレイ UI を非同期で表示し、プレーヤーがマルチプレーヤー招待を選択できるようにします。

完了すると、選択した招待状が RoomInboxUIResponse を介して返されます。

ShowRoomInboxUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

ShowRoomInboxUI のブロック バージョン。

呼び出し元がタイムアウトをミリ秒単位で指定できます。指定された時間が経過すると、関数は ERROR_TIMEOUT を返します。

ShowRoomInboxUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking()

デフォルトのタイムアウトが 10 年のデフォルトの ShowRoomInboxUIBlocking のオーバーロード。

ShowWaitingRoomUI

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

この部屋に参加する MultiplayerParticipants のステータスを表示する待機室 UI が表示されます。

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
)

デフォルトのタイムアウトが 10 年になる ShowWaitingRoomUIBlocking のオーバーロード。