gpg::RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

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

まとめ

パブリック タイプ
FetchInvitationsCallback	typedef std::function< void(const FetchInvitationsResponse &)> リアルタイムのマルチプレーヤー オペレーションの 1 つから WaitingRoomUIResponse を受け取るために使用できるコールバックを定義します。
LeaveRoomCallback	typedef std::function< void(const ResponseStatus &)> LeaveRoom から ResponseStatus を受け取ることができるコールバックを定義します。
PlayerSelectUICallback	typedef std::function< void(const PlayerSelectUIResponse &)> ShowPlayerSelectUI から PlayerSelectUIResponse を受け取ることができるコールバックを定義します。
PlayerSelectUIResponse	typedef TurnBasedMultiplayerManager::PlayerSelectUIResponse ShowPlayerSelectUI オペレーションの場合、Data と ResponseStatus。
RealTimeRoomCallback	typedef std::function< void(const RealTimeRoomResponse &)> ターンベースのマルチプレーヤー オペレーションの 1 つから 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 &)> リアルタイムのマルチプレーヤー オペレーションの 1 つから 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)	RealTimeRoomResponse AcceptInvitation のブロック バージョン。
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)	RealTimeRoomResponse デフォルトのタイムアウト（10 年）を使用する AcceptInvitationBlocked のオーバーロード。
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)	RealTimeRoomResponse AcceptInvitation のブロック バージョン。
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)	RealTimeRoomResponse デフォルトのタイムアウト（10 年）を使用する AcceptInvitationBlocked のオーバーロード。
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)	RealTimeRoomResponse CreateRealTimeRoom のブロック バージョン。
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)	RealTimeRoomResponse デフォルトのタイムアウト（10 年）を使用する CreateRealTimeRoomBlocked のオーバーロード。
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)	RealTimeRoomResponse CreateRealTimeRoom のブロック バージョン。
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)	RealTimeRoomResponse デフォルトのタイムアウト（10 年）を使用する CreateRealTimeRoomBlocked のオーバーロード。
DeclineInvitation(const MultiplayerInvitation & invitation)	void MultiplayerInvitation を RealTimeRoom に拒否します。
DismissInvitation(const MultiplayerInvitation & invitation)	void MultiplayerInvitation を RealTimeRoom を閉じます。
FetchInvitations(FetchInvitationsCallback callback)	void リアルタイム ルームの MultiplayerInvitation を取得します。
FetchInvitationsBlocking(Timeout timeout)	FetchInvitationsResponse FetchInvitations のブロック バージョン。
FetchInvitationsBlocking()	FetchInvitationsResponse FetchInvitationsBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)	void RealTimeRoom を終了します。
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)	ResponseStatus LeaveRoom のブロック バージョン。
LeaveRoomBlocking(const RealTimeRoom & room)	ResponseStatus デフォルトのタイムアウト（10 年）を使用する LeaveRoomBlocked のオーバーロード。
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)	MultiplayerStatus SendReliableMessage のブロック バージョン。
SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)	MultiplayerStatus SendReliableMessageBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。
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)	PlayerSelectUIResponse ShowPlayerSelectUI のブロック バージョン。
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)	PlayerSelectUIResponse ShowPlayerSelectUIBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。
ShowRoomInboxUI(RoomInboxUICallback callback)	void ルーム 受信トレイの UI が非同期で表示される。これにより、プレーヤーがマルチプレーヤー招待を選択できる。
ShowRoomInboxUIBlocking(Timeout timeout)	RoomInboxUIResponse ShowRoomInboxUI のブロック バージョン。
ShowRoomInboxUIBlocking()	RoomInboxUIResponse ShowRoomInboxUIBlocked のオーバーロード。デフォルトのタイムアウトは 10 年です。
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)	void 待合室の UI に、このマルチプレーヤー セッションに参加しているマルチプレーヤー参加者のステータスが表示されます。
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)	WaitingRoomUIResponse ShowWaitRoomUI のブロック バージョン。
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)	WaitingRoomUIResponse デフォルトのタイムアウト（10 年）を使用する ShowWaitRoomUIBlocked のオーバーロード。

構造体
gpg::RealTimeMultiplayerManager::FetchInvitationsResponse	FetchInvitations オペレーションの場合、Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::RealTimeRoomResponse	特定の RealTimeRoom オブジェクトの Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::RoomInboxUIResponse	ShowRoomInboxUI オペレーションの場合、Data と ResponseStatus。
gpg::RealTimeMultiplayerManager::WaitRoomUIResponse	ShowWaitingRoomUI オペレーションの場合、Data と ResponseStatus。

パブリック タイプ

FetchInvitationsCallback

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

リアルタイムのマルチプレーヤー オペレーションの 1 つから 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

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

RoomInboxUICallback

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

ShowRoomInboxUI から RoomInboxUIResponse を受け取ることができるコールバックを定義します。

SendReliableMessageCallback

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

SendReliableMessage から ResponseStatus を受け取ることができるコールバックを定義します。

WaitRoomUICallback

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

リアルタイムのマルチプレーヤー オペレーションの 1 つから 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
)

デフォルトのタイムアウト（10 年）を使用する AcceptInvitationBlocked のオーバーロード。

招待のブロック

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

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

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

招待のブロック

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

デフォルトのタイムアウト（10 年）を使用する AcceptInvitationBlocked のオーバーロード。

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 オブジェクトを返します。

CreateRealTimeRoomBlock

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

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

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

CreateRealTimeRoomBlock

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

デフォルトのタイムアウト（10 年）を使用する CreateRealTimeRoomBlocked のオーバーロード。

CreateRealTimeRoomBlock

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

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

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

CreateRealTimeRoomBlock

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

デフォルトのタイムアウト（10 年）を使用する CreateRealTimeRoomBlocked のオーバーロード。

招待を辞退

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()

FetchInvitationsBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。

退出

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

RealTimeRoom を終了します。

このオペレーションが完了するまで、新しいチャットルームを作成したり、別のチャットルームに入室したりしないでください。このオペレーションの結果は、LeaveRoomCallback を介して返されます。

LeaveRoom ブロック

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

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

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

LeaveRoom ブロック

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

デフォルトのタイムアウト（10 年）を使用する LeaveRoomBlocked のオーバーロード。

SendReliableMessage

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

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

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

SendReliableMessageBlocked

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

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

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

SendReliableMessageBlocked

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

SendReliableMessageBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。

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 を介して返されます。

ShowPlayerSelectUIBlock

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

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

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

ShowPlayerSelectUIBlock

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

ShowPlayerSelectUIBlocked のオーバーロード。デフォルトのタイムアウトは 10 年間です。

ショールーム受信トレイ UI

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

ルーム 受信トレイの UI が非同期で表示される。これにより、プレーヤーがマルチプレーヤー招待を選択できる。

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

ショールーム受信トレイ UI ブロック

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

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

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

ショールーム受信トレイ UI ブロック

RoomInboxUIResponse ShowRoomInboxUIBlocking()

ShowRoomInboxUIBlocked のオーバーロード。デフォルトのタイムアウトは 10 年です。

ShowWaitRoomUI

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

待合室の UI に、このマルチプレーヤー セッションに参加しているマルチプレーヤー参加者のステータスが表示されます。

ShowWaitRoomUIBlock

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

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

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

ShowWaitRoomUIBlock

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

デフォルトのタイムアウト（10 年）を使用する ShowWaitRoomUIBlocked のオーバーロード。