gpg:: RealTimeMultiplayerManager
#include <real_time_multiplayer_manager.h>
Récupère, modifie, gère les messages et crée des objets RealTimeRoom
.
Résumé
Types publics |
|
---|---|
FetchInvitationsCallback
|
typedefstd::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
|
typedefstd::function< void(const ResponseStatus &)>
Définit un rappel pouvant recevoir un ResponseStatus de LeaveRoom . |
PlayerSelectUICallback
|
typedefstd::function< void(const PlayerSelectUIResponse &)>
Définit un rappel pouvant recevoir un PlayerSelectUIResponse de ShowPlayerSelectUI . |
PlayerSelectUIResponse
|
typedefData et ResponseStatus pour l'opération ShowPlayerSelectUI . |
RealTimeRoomCallback
|
typedefstd::function< void(const RealTimeRoomResponse &)>
Définit un rappel qui peut être utilisé pour recevoir une structure RealTimeRoomResponse à partir de l'une des opérations multijoueurs au tour par tour. |
RoomInboxUICallback
|
typedefstd::function< void(const RoomInboxUIResponse &)>
Définit un rappel pouvant recevoir un RoomInboxUIResponse de ShowRoomInboxUI . |
SendReliableMessageCallback
|
typedefstd::function< void(const MultiplayerStatus &)>
Définit un rappel pouvant recevoir un ResponseStatus de SendReliableMessage . |
WaitingRoomUICallback
|
typedefstd::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 de manière asynchrone un
MultiplayerInvitation et renvoie le résultat via une RealTimeRoomCallback . |
AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
Accepte de manière asynchrone un
MultiplayerInvitation et renvoie le résultat via une RealTimeRoomCallback . |
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
Blocage de la version d'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)
|
Blocage de la version d'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)
|
Blocage de la version 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)
|
Blocage de la version 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
Refuse un
MultiplayerInvitation en RealTimeRoom . |
DismissInvitation(const MultiplayerInvitation & invitation)
|
void
Ignore une
MultiplayerInvitation en RealTimeRoom . |
FetchInvitations(FetchInvitationsCallback callback)
|
void
Récupère tous les
MultiplayerInvitation pour les salles en temps réel. |
FetchInvitationsBlocking(Timeout timeout)
|
Version bloquante 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
Quitte un
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 sélectionnée, ce qui permet au joueur 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)
|
Blocage de la version 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 de la salle, ce qui permet au joueur de sélectionner une invitation à un jeu multijoueur.
|
ShowRoomInboxUIBlocking(Timeout timeout)
|
Blocage de la version 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 qui indique l'état des MultiplayerParticipants 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:: |
|
gpg:: |
|
gpg:: |
|
gpg:: |
|
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 pouvant recevoir un ResponseStatus
de LeaveRoom
.
PlayerSelectUICallback
std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback
Définit un rappel pouvant recevoir un PlayerSelectUIResponse
de ShowPlayerSelectUI
.
PlayerSelectUIResponse
TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse
Data
et ResponseStatus
pour l'opération ShowPlayerSelectUI
.
Ce contenu est partagé avec le mode multijoueur au tour par tour.
RealTimeRoomCallback
std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback
Définit un rappel qui peut être utilisé pour recevoir une structure RealTimeRoomResponse
à partir de l'une des opérations multijoueurs au tour par tour.
RoomInboxUICallback
std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback
Définit un rappel pouvant recevoir un RoomInboxUIResponse
de ShowRoomInboxUI
.
SendReliableMessageCallback
std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback
Définit un rappel pouvant 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 de manière asynchrone un MultiplayerInvitation
et renvoie le résultat via une RealTimeRoomCallback
.
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
Accepte de manière asynchrone un MultiplayerInvitation
et renvoie le résultat via une RealTimeRoomCallback
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
Blocage de la version d'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 )
Blocage de la version d'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 l'élément 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 l'élément RealTimeRoomCallback
fourni.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
Blocage de la version 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 )
Blocage de la version 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 )
Refuse un MultiplayerInvitation
en RealTimeRoom
.
Cela annule la salle pour les autres participants et la supprime de l'appareil du joueur local.
DismissInvitation
void DismissInvitation( const MultiplayerInvitation & invitation )
Ignore une MultiplayerInvitation
en RealTimeRoom
.
Cela ne modifie pas l'état visible du RealTimeRoom
pour les autres participants, mais le supprime de l'appareil du joueur local.
FetchInvitations
void FetchInvitations( FetchInvitationsCallback callback )
Récupère tous les MultiplayerInvitation
pour les salles en temps réel.
Les éléments MultiplayerInvitation
récupérés sont renvoyés via l'élément FetchInvitationsCallback
fourni.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking( Timeout timeout )
Version bloquante de FetchInvitations.
Permet à l'appelant de spécifier un délai avant expiration en millisecondes. Une fois le temps é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 )
Quitte un RealTimeRoom
.
Vous ne devez pas créer de salon ni essayer d'en rejoindre un autre tant que cette opération n'est pas terminée. Le résultat de cette opération est renvoyé via un 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 de manière non 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 de 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 de 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 sélectionnée, ce qui permet au joueur de sélectionner d'autres joueurs avec lesquels rejoindre une salle.
Une fois l'opération terminée, les joueurs sélectionnés seront renvoyés via le PlayerSelectUICallback
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
Blocage de la version 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 de la salle, ce qui permet au joueur de sélectionner une invitation à un jeu multijoueur.
Une fois l'opération terminée, l'invitation sélectionnée est renvoyée via RoomInboxUIResponse
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking( Timeout timeout )
Blocage de la version 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 qui indique l'état des MultiplayerParticipants 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 temps é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