gpg::RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

Récupère, modifie et gère la messagerie pour les objets RealTimeRoom.

Résumé

Types publics
FetchInvitationsCallback typedef
std::function< void(const FetchInvitationsResponse &)>
Définit un rappel qui peut être utilisé pour recevoir un WaitingRoomUIResponse de l'une des opérations multijoueurs en temps réel.
LeaveRoomCallback typedef
std::function< void(const ResponseStatus &)>
Définit un rappel qui peut recevoir un ResponseStatus de LeaveRoom.
PlayerSelectUICallback typedef
std::function< void(const PlayerSelectUIResponse &)>
Définit un rappel qui peut recevoir un PlayerSelectUIResponse de ShowPlayerSelectUI.
PlayerSelectUIResponse typedef
Data et ResponseStatus pour l'opération ShowPlayerSelectUI.
RealTimeRoomCallback typedef
std::function< void(const RealTimeRoomResponse &)>
Définit un rappel qui peut être utilisé pour recevoir une structure RealTimeRoomResponse de l'une des opérations multijoueurs au tour par tour.
RoomInboxUICallback typedef
std::function< void(const RoomInboxUIResponse &)>
Définit un rappel qui peut recevoir un RoomInboxUIResponse de ShowRoomInboxUI.
SendReliableMessageCallback typedef
std::function< void(const MultiplayerStatus &)>
Définit un rappel qui peut recevoir un ResponseStatus de SendReliableMessage.
WaitingRoomUICallback typedef
std::function< void(const WaitingRoomUIResponse &)>
Définit un rappel qui peut être utilisé pour recevoir un WaitingRoomUIResponse de l'une des opérations multijoueurs en temps réel.

Fonctions publiques
AcceptInvitation(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
Accepte un MultiplayerInvitation de manière asynchrone et renvoie le résultat via un RealTimeRoomCallback.
AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
Accepte un MultiplayerInvitation de manière asynchrone et renvoie le résultat via un RealTimeRoomCallback.
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
Version bloquante de AcceptInvitation.
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
Surcharge de AcceptInvitationBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Version bloquante de AcceptInvitation.
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
Surcharge de AcceptInvitationBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
void
Crée un objet RealTimeRoom de manière asynchrone à l'aide de la classe RealTimeRoomConfig fournie.
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
void
Crée un objet RealTimeRoom de manière asynchrone à l'aide de la classe RealTimeRoomConfig fournie.
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Version bloquante de CreateRealTimeRoom.
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
Surcharge de CreateRealTimeRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Version bloquante de CreateRealTimeRoom.
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
Surcharge de CreateRealTimeRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
DeclineInvitation(const MultiplayerInvitation & invitation)
void
Remplace une MultiplayerInvitation par une RealTimeRoom.
DismissInvitation(const MultiplayerInvitation & invitation)
void
FetchInvitations(FetchInvitationsCallback callback)
void
Extrait tous les MultiplayerInvitation pour les salles en temps réel.
FetchInvitationsBlocking(Timeout timeout)
Version bloquant de FetchInvitations.
FetchInvitationsBlocking()
Surcharge de FetchInvitationsBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)
void
Affiche une valeur RealTimeRoom.
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)
Blocage de la version de LeaveRoom.
LeaveRoomBlocking(const RealTimeRoom & room)
Surcharge de LeaveRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
SendReliableMessage(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)
void
Envoie un message au MultiplayerParticipant spécifié.
SendReliableMessageBlocking(Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
Version bloquante de SendReliableMessage.
SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
Surcharge de SendReliableMessageBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
void
Envoie un message aux MultiplayerParticipant spécifiés.
SendUnreliableMessageToOthers(const RealTimeRoom & room, std::vector< uint8_t > data)
void
Envoie un message à tous les participants autres que l'utilisateur actuel.
ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
void
Affiche de manière asynchrone l'interface utilisateur de sélection du joueur, ce qui lui permet de sélectionner d'autres joueurs avec lesquels rejoindre une salle.
ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
Version bloquante de ShowPlayerSelectUI
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
Surcharge de ShowPlayerSelectUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans.
ShowRoomInboxUI(RoomInboxUICallback callback)
void
Affiche de manière asynchrone l'interface utilisateur de la boîte de réception des salles, ce qui permet au joueur de sélectionner une invitation multijoueur.
ShowRoomInboxUIBlocking(Timeout timeout)
Version bloquante de ShowRoomInboxUI
ShowRoomInboxUIBlocking()
Surcharge de ShowRoomInboxUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
void
Affiche une interface utilisateur de salle d'attente indiquant l'état des participants multijoueurs qui rejoignent cette salle.
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
Version bloquante de ShowWaitingRoomUI
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)
Surcharge de ShowWaitingRoomUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans

Structs
gpg::RealTimeMultiplayerManager::FetchInvitationsResponse

Data et ResponseStatus pour l'opération FetchInvitations.

gpg::RealTimeMultiplayerManager::RealTimeRoomResponse

Data et ResponseStatus pour un objet RealTimeRoom spécifique.

gpg::RealTimeMultiplayerManager::RoomInboxUIResponse

Data et ResponseStatus pour l'opération ShowRoomInboxUI.

gpg::RealTimeMultiplayerManager::WaitingRoomUIResponse

Data et ResponseStatus pour l'opération ShowWaitingRoomUI.

Types publics

FetchInvitationsCallback

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

Définit un rappel qui peut être utilisé pour recevoir un WaitingRoomUIResponse de l'une des opérations multijoueurs en temps réel.

LeaveRoomCallback

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

Définit un rappel qui peut recevoir un ResponseStatus de LeaveRoom.

PlayerSelectUICallback

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

Définit un rappel qui peut recevoir un PlayerSelectUIResponse de ShowPlayerSelectUI.

PlayerSelectUIResponse

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

Data et ResponseStatus pour l'opération ShowPlayerSelectUI.

Cette information est partagée avec le mode multijoueur en tour par tour.

RealTimeRoomCallback

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

Définit un rappel qui peut être utilisé pour recevoir une structure RealTimeRoomResponse de l'une des opérations multijoueurs au tour par tour.

RoomInboxUICallback

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

Définit un rappel qui peut recevoir un RoomInboxUIResponse de ShowRoomInboxUI.

SendReliableMessageCallback

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

Définit un rappel qui peut recevoir un ResponseStatus de SendReliableMessage.

WaitingRoomUICallback

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

Définit un rappel qui peut être utilisé pour recevoir un WaitingRoomUIResponse de l'une des opérations multijoueurs en temps réel.

Fonctions publiques

AcceptInvitation

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

Accepte un MultiplayerInvitation de manière asynchrone et renvoie le résultat via un RealTimeRoomCallback.

AcceptInvitation

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

Accepte un MultiplayerInvitation de manière asynchrone et renvoie le résultat via un RealTimeRoomCallback.

AcceptInvitationBlocking

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

Version bloquante de AcceptInvitation.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

AcceptInvitationBlocking

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

Surcharge de AcceptInvitationBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

AcceptInvitationBlocking

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

Version bloquante de AcceptInvitation.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

AcceptInvitationBlocking

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

Surcharge de AcceptInvitationBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

CreateRealTimeRoom

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

Crée un objet RealTimeRoom de manière asynchrone à l'aide de la classe RealTimeRoomConfig fournie.

Si la création aboutit, cette fonction renvoie l'objet RealTimeRoom via le RealTimeRoomCallback fourni.

CreateRealTimeRoom

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

Crée un objet RealTimeRoom de manière asynchrone à l'aide de la classe RealTimeRoomConfig fournie.

Si la création aboutit, cette fonction renvoie l'objet RealTimeRoom via le RealTimeRoomCallback fourni.

CreateRealTimeRoomBlocking

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

Version bloquante de CreateRealTimeRoom.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

CreateRealTimeRoomBlocking

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

Surcharge de CreateRealTimeRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

CreateRealTimeRoomBlocking

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

Version bloquante de CreateRealTimeRoom.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

Surcharge de CreateRealTimeRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

DeclineInvitation

void DeclineInvitation(
  const MultiplayerInvitation & invitation
)

Remplace une MultiplayerInvitation par une RealTimeRoom.

Cette action annule la salle pour les autres participants et la supprime de l'appareil du joueur local.

DismissInvitation

void DismissInvitation(
  const MultiplayerInvitation & invitation
)

Ignore un MultiplayerInvitation en RealTimeRoom.

Cela ne modifie pas l'état visible de l'RealTimeRoom pour les autres participants, mais le supprime de l'appareil du lecteur local.

FetchInvitations

void FetchInvitations(
  FetchInvitationsCallback callback
)

Extrait tous les MultiplayerInvitation pour les salles en temps réel.

Les objets MultiplayerInvitation récupérés sont renvoyés via le FetchInvitationsCallback fourni.

FetchInvitationsBlocking

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

Version bloquant de FetchInvitations.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

FetchInvitationsBlocking

FetchInvitationsResponse FetchInvitationsBlocking()

Surcharge de FetchInvitationsBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

LeaveRoom

void LeaveRoom(
  const RealTimeRoom & room,
  LeaveRoomCallback callback
)

Affiche une valeur RealTimeRoom.

Vous ne devez pas créer de salon ni tenter de rejoindre un autre salon tant que cette opération n'est pas terminée. Le résultat de cette opération est renvoyé via LeaveRoomCallback.

LeaveRoomBlocking

ResponseStatus LeaveRoomBlocking(
  Timeout timeout,
  const RealTimeRoom & room
)

Blocage de la version de LeaveRoom.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

LeaveRoomBlocking

ResponseStatus LeaveRoomBlocking(
  const RealTimeRoom & room
)

Surcharge de LeaveRoomBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

SendReliableMessage

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

Envoie un message au MultiplayerParticipant spécifié.

Utilise une méthode fiable pour envoyer le message. Cette méthode d'envoi de données peut prendre plus de temps que l'envoi d'un message peu fiable. Le résultat de l'envoi est signalé via le rappel fourni.

SendReliableMessageBlocking

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

Version bloquante de SendReliableMessage.

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

SendReliableMessageBlocking

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

Surcharge de SendReliableMessageBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

SendUnreliableMessage

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

Envoie un message aux MultiplayerParticipant spécifiés.

Utilise une méthode non fiable pour envoyer le message. Cette méthode d'envoi des données est plus rapide que l'envoi fiable et doit être préférable si possible.

SendUnreliableMessageToOthers

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

Envoie un message à tous les participants autres que l'utilisateur actuel.

Utilise une méthode non fiable pour envoyer le message. Cette méthode d'envoi des données est plus rapide que l'envoi fiable et doit être préférable si possible.

ShowPlayerSelectUI

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

Affiche de manière asynchrone l'interface utilisateur de sélection du joueur, ce qui lui permet de sélectionner d'autres joueurs avec lesquels rejoindre une salle.

Une fois l'opération terminée, les joueurs sélectionnés sont renvoyés via le PlayerSelectUICallback.

ShowPlayerSelectUIBlocking

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

Version bloquante de ShowPlayerSelectUI

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

ShowPlayerSelectUIBlocking

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

Surcharge de ShowPlayerSelectUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans.

ShowRoomInboxUI

void ShowRoomInboxUI(
  RoomInboxUICallback callback
)

Affiche de manière asynchrone l'interface utilisateur de la boîte de réception des salles, ce qui permet au joueur de sélectionner une invitation multijoueur.

Une fois l'opération terminée, l'invitation sélectionnée est renvoyée via RoomInboxUIResponse.

ShowRoomInboxUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking(
  Timeout timeout
)

Version bloquante de ShowRoomInboxUI

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

ShowRoomInboxUIBlocking

RoomInboxUIResponse ShowRoomInboxUIBlocking()

Surcharge de ShowRoomInboxUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans

ShowWaitingRoomUI

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

Affiche une interface utilisateur de salle d'attente indiquant l'état des participants multijoueurs qui rejoignent cette salle.

ShowWaitingRoomUIBlocking

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

Version bloquante de ShowWaitingRoomUI

Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le délai spécifié écoulé, la fonction renvoie ERROR_TIMEOUT.

ShowWaitingRoomUIBlocking

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

Surcharge de ShowWaitingRoomUIBlocking, qui utilise un délai avant expiration par défaut de 10 ans