gpg:: RealTimeMultiplayerManager
#include <real_time_multiplayer_manager.h>
Busca, modifica, processa mensagens e cria objetos RealTimeRoom
.
Resumo
Tipos públicos |
|
---|---|
FetchInvitationsCallback
|
typedefstd::function< void(const FetchInvitationsResponse &)>
Define um callback que pode ser usado para receber um WaitingRoomUIResponse de uma das operações multiplayer em tempo real. |
LeaveRoomCallback
|
typedefstd::function< void(const ResponseStatus &)>
Define um callback que pode receber um ResponseStatus de LeaveRoom . |
PlayerSelectUICallback
|
typedefstd::function< void(const PlayerSelectUIResponse &)>
Define um callback que pode receber um PlayerSelectUIResponse de ShowPlayerSelectUI . |
PlayerSelectUIResponse
|
typedefData e ResponseStatus para a operação ShowPlayerSelectUI . |
RealTimeRoomCallback
|
typedefstd::function< void(const RealTimeRoomResponse &)>
Define um callback que pode ser usado para receber um struct RealTimeRoomResponse de uma das operações multiplayer com base em turnos. |
RoomInboxUICallback
|
typedefstd::function< void(const RoomInboxUIResponse &)>
Define um callback que pode receber um RoomInboxUIResponse de ShowRoomInboxUI . |
SendReliableMessageCallback
|
typedefstd::function< void(const MultiplayerStatus &)>
Define um callback que pode receber um ResponseStatus de SendReliableMessage . |
WaitingRoomUICallback
|
typedefstd::function< void(const WaitingRoomUIResponse &)>
Define um callback que pode ser usado para receber um WaitingRoomUIResponse de uma das operações multiplayer em tempo real. |
Funções públicas |
|
---|---|
AcceptInvitation(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
Aceita de maneira assíncrona uma
MultiplayerInvitation e retorna o resultado por uma RealTimeRoomCallback . |
AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
Aceita de maneira assíncrona uma
MultiplayerInvitation e retorna o resultado por uma RealTimeRoomCallback . |
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
Bloqueando a versão de AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
Sobrecarga de AcceptInvitationBlocking, que usa um tempo limite padrão de 10 anos.
|
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
Bloqueando a versão de AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
Sobrecarga de AcceptInvitationBlocking, que usa um tempo limite padrão de 10 anos.
|
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
Cria de maneira assíncrona um objeto
RealTimeRoom usando a classe RealTimeRoomConfig fornecida. |
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
Cria de maneira assíncrona um objeto
RealTimeRoom usando a classe RealTimeRoomConfig fornecida. |
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
Bloquear a versão do CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
Sobrecarga de CreateRealTimeRoomBlocking, que usa um tempo limite padrão de 10 anos.
|
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
Bloquear a versão do CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
Sobrecarga de CreateRealTimeRoomBlocking, que usa um tempo limite padrão de 10 anos.
|
DeclineInvitation(const MultiplayerInvitation & invitation)
|
void
Recusa
MultiplayerInvitation para RealTimeRoom . |
DismissInvitation(const MultiplayerInvitation & invitation)
|
void
Dispensa um
MultiplayerInvitation para um RealTimeRoom . |
FetchInvitations(FetchInvitationsCallback callback)
|
void
Busca qualquer
MultiplayerInvitation para salas em tempo real. |
FetchInvitationsBlocking(Timeout timeout)
|
Bloqueando a versão de FetchInvitations.
|
FetchInvitationsBlocking()
|
Sobrecarga de FetchInvitationsBlocking, que usa um tempo limite padrão de 10 anos.
|
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)
|
void
Deixa um
RealTimeRoom . |
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)
|
Bloqueando a versão da LeaveRoom.
|
LeaveRoomBlocking(const RealTimeRoom & room)
|
Sobrecarga de LeaveRoomBlocking, que usa um tempo limite padrão de 10 anos.
|
SendReliableMessage(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)
|
void
Envia uma mensagem para o
MultiplayerParticipant especificado. |
SendReliableMessageBlocking(Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
Bloqueando a versão de SendReliableMessage.
|
SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
Sobrecarga de SendReliableMessageBlocking, que usa um tempo limite padrão de 10 anos.
|
SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
|
void
Envia uma mensagem para as
MultiplayerParticipant s especificadas. |
SendUnreliableMessageToOthers(const RealTimeRoom & room, std::vector< uint8_t > data)
|
void
Envia uma mensagem para todos os participantes, exceto o usuário atual.
|
ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
|
void
Mostra de forma assíncrona a interface de seleção do jogador, permitindo que ele selecione outros jogadores para participar de uma sala.
|
ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
Versão de bloqueio de ShowPlayerSelectUI.
|
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
Sobrecarga de ShowPlayerSelectUIBlocking, que usa um tempo limite padrão de 10 anos.
|
ShowRoomInboxUI(RoomInboxUICallback callback)
|
void
Mostra de forma assíncrona a interface da caixa de entrada da sala, permitindo que o jogador selecione um convite multiplayer.
|
ShowRoomInboxUIBlocking(Timeout timeout)
|
Bloqueio da versão da ShowRoomInboxUI.
|
ShowRoomInboxUIBlocking()
|
Sobrecarga de ShowRoomInboxUIBlocking, que usa um tempo limite padrão de 10 anos.
|
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
|
void
Mostra uma interface de sala de espera com o status dos participantes do multiplayer que estão entrando nesta sala.
|
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
|
Bloqueando a versão da ShowWaitingRoomUI.
|
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)
|
Sobrecarga de ShowWaitingRoomUIBlocking, que usa um tempo limite padrão de 10 anos.
|
Estruturas |
|
---|---|
gpg:: |
|
gpg:: |
|
gpg:: |
|
gpg:: |
|
Tipos públicos
FetchInvitationsCallback
std::function< void(const FetchInvitationsResponse &)> FetchInvitationsCallback
Define um callback que pode ser usado para receber um WaitingRoomUIResponse
de uma das operações multiplayer em tempo real.
LeaveRoomCallback
std::function< void(const ResponseStatus &)> LeaveRoomCallback
Define um callback que pode receber um ResponseStatus
de LeaveRoom
.
PlayerSelectUICallback
std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback
Define um callback que pode receber um PlayerSelectUIResponse
de ShowPlayerSelectUI
.
PlayerSelectUIResponse
TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse
Data
e ResponseStatus
para a operação ShowPlayerSelectUI
.
Isso é compartilhado com o modo multiplayer baseado em turnos.
RealTimeRoomCallback
std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback
Define um callback que pode ser usado para receber um struct RealTimeRoomResponse
de uma das operações multiplayer com base em turnos.
RoomInboxUICallback
std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback
Define um callback que pode receber um RoomInboxUIResponse
de ShowRoomInboxUI
.
SendReliableMessageCallback
std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback
Define um callback que pode receber um ResponseStatus
de SendReliableMessage
.
WaitingRoomUICallback
std::function< void(const WaitingRoomUIResponse &)> WaitingRoomUICallback
Define um callback que pode ser usado para receber um WaitingRoomUIResponse
de uma das operações multiplayer em tempo real.
Funções públicas
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
Aceita de maneira assíncrona uma MultiplayerInvitation
e retorna o resultado por uma RealTimeRoomCallback
.
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
Aceita de maneira assíncrona uma MultiplayerInvitation
e retorna o resultado por uma RealTimeRoomCallback
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
Bloqueando a versão de AcceptInvitation.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
Sobrecarga de AcceptInvitationBlocking, que usa um tempo limite padrão de 10 anos.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
Bloqueando a versão de AcceptInvitation.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
Sobrecarga de AcceptInvitationBlocking, que usa um tempo limite padrão de 10 anos.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
Cria de maneira assíncrona um objeto RealTimeRoom
usando a classe RealTimeRoomConfig
fornecida.
Se a criação for bem-sucedida, essa função retornará o objeto RealTimeRoom
usando o RealTimeRoomCallback
fornecido.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
Cria de maneira assíncrona um objeto RealTimeRoom
usando a classe RealTimeRoomConfig
fornecida.
Se a criação for bem-sucedida, essa função retornará o objeto RealTimeRoom
usando o RealTimeRoomCallback
fornecido.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
Bloquear a versão do CreateRealTimeRoom.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
Sobrecarga de CreateRealTimeRoomBlocking, que usa um tempo limite padrão de 10 anos.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
Bloquear a versão do CreateRealTimeRoom.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
Sobrecarga de CreateRealTimeRoomBlocking, que usa um tempo limite padrão de 10 anos.
DeclineInvitation
void DeclineInvitation( const MultiplayerInvitation & invitation )
Recusa MultiplayerInvitation
para RealTimeRoom
.
Isso cancela a sala para os outros participantes e a remove do dispositivo do jogador local.
DismissInvitation
void DismissInvitation( const MultiplayerInvitation & invitation )
Dispensa um MultiplayerInvitation
para um RealTimeRoom
.
Isso não muda o estado visível da RealTimeRoom
para os outros participantes, mas a remove do dispositivo do jogador local.
FetchInvitations
void FetchInvitations( FetchInvitationsCallback callback )
Busca qualquer MultiplayerInvitation
para salas em tempo real.
Os MultiplayerInvitation
s buscados são retornados pelo FetchInvitationsCallback
fornecido.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking( Timeout timeout )
Bloqueando a versão de FetchInvitations.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking()
Sobrecarga de FetchInvitationsBlocking, que usa um tempo limite padrão de 10 anos.
LeaveRoom
void LeaveRoom( const RealTimeRoom & room, LeaveRoomCallback callback )
Deixa um RealTimeRoom
.
Não crie uma nova sala nem tente participar de outra até que essa operação seja concluída. O resultado dessa operação é retornado por uma LeaveRoomCallback
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( Timeout timeout, const RealTimeRoom & room )
Bloqueando a versão da LeaveRoom.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( const RealTimeRoom & room )
Sobrecarga de LeaveRoomBlocking, que usa um tempo limite padrão de 10 anos.
SendReliableMessage
void SendReliableMessage( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback )
Envia uma mensagem para o MultiplayerParticipant
especificado.
Usa um método confiável para enviar a mensagem. Esse método de envio de dados pode demorar mais do que enviar uma mensagem não confiável. O resultado do envio é informado pelo callback fornecido.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
Bloqueando a versão de SendReliableMessage.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
Sobrecarga de SendReliableMessageBlocking, que usa um tempo limite padrão de 10 anos.
SendUnreliableMessage
void SendUnreliableMessage( const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data )
Envia uma mensagem para as MultiplayerParticipant
s especificadas.
Usa um método não confiável para enviar a mensagem. Esse método de envio de dados é mais rápido do que o envio confiável de dados e deve ser preferível, se possível.
SendUnreliableMessageToOthers
void SendUnreliableMessageToOthers( const RealTimeRoom & room, std::vector< uint8_t > data )
Envia uma mensagem para todos os participantes, exceto o usuário atual.
Usa um método não confiável para enviar a mensagem. Esse método de envio de dados é mais rápido do que o envio confiável de dados e deve ser preferível, se possível.
ShowPlayerSelectUI
void ShowPlayerSelectUI( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback )
Mostra de forma assíncrona a interface de seleção do jogador, permitindo que ele selecione outros jogadores para participar de uma sala.
Após a conclusão, os jogadores selecionados serão retornados pelo PlayerSelectUICallback
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
Versão de bloqueio de ShowPlayerSelectUI.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
Sobrecarga de ShowPlayerSelectUIBlocking, que usa um tempo limite padrão de 10 anos.
ShowRoomInboxUI
void ShowRoomInboxUI( RoomInboxUICallback callback )
Mostra de forma assíncrona a interface da caixa de entrada da sala, permitindo que o jogador selecione um convite multiplayer.
Após a conclusão, o convite selecionado é retornado pelo RoomInboxUIResponse
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking( Timeout timeout )
Bloqueio da versão da ShowRoomInboxUI.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking()
Sobrecarga de ShowRoomInboxUIBlocking, que usa um tempo limite padrão de 10 anos.
ShowWaitingRoomUI
void ShowWaitingRoomUI( const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback )
Mostra uma interface de sala de espera com o status dos participantes do multiplayer que estão entrando nesta sala.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start )
Bloqueando a versão da ShowWaitingRoomUI.
Permite que o autor da chamada especifique um tempo limite em ms. Após o tempo especificado, a função retornará ERROR_TIMEOUT
.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( const RealTimeRoom & room, uint32_t min_participants_to_start )
Sobrecarga de ShowWaitingRoomUIBlocking, que usa um tempo limite padrão de 10 anos.