gpg:: RealTimeMultiplayerManager
#include <real_time_multiplayer_manager.h>
Pobiera, modyfikuje i obsługuje komunikaty oraz tworzy obiekty RealTimeRoom
.
Podsumowanie
Typy publiczne |
|
---|---|
FetchInvitationsCallback
|
typedefstd::function< void(const FetchInvitationsResponse &)>
Określa wywołanie zwrotne, za pomocą którego można odebrać WaitingRoomUIResponse z jednej z operacji multiplayer w czasie rzeczywistym. |
LeaveRoomCallback
|
typedefstd::function< void(const ResponseStatus &)>
Definiuje wywołanie zwrotne, do którego można odebrać ResponseStatus z urządzenia LeaveRoom . |
PlayerSelectUICallback
|
typedefstd::function< void(const PlayerSelectUIResponse &)>
Definiuje wywołanie zwrotne, do którego można odebrać PlayerSelectUIResponse z urządzenia ShowPlayerSelectUI . |
PlayerSelectUIResponse
|
typedefData i ResponseStatus dla operacji ShowPlayerSelectUI . |
RealTimeRoomCallback
|
typedefstd::function< void(const RealTimeRoomResponse &)>
Definiuje wywołanie zwrotne, które może zostać użyte do otrzymania elementu struct RealTimeRoomResponse z jednej z turowych operacji wieloosobowych. |
RoomInboxUICallback
|
typedefstd::function< void(const RoomInboxUIResponse &)>
Definiuje wywołanie zwrotne, do którego można odebrać RoomInboxUIResponse z urządzenia ShowRoomInboxUI . |
SendReliableMessageCallback
|
typedefstd::function< void(const MultiplayerStatus &)>
Definiuje wywołanie zwrotne, do którego można odebrać ResponseStatus z urządzenia SendReliableMessage . |
WaitingRoomUICallback
|
typedefstd::function< void(const WaitingRoomUIResponse &)>
Określa wywołanie zwrotne, za pomocą którego można odebrać WaitingRoomUIResponse z jednej z operacji multiplayer w czasie rzeczywistym. |
Funkcje publiczne |
|
---|---|
AcceptInvitation(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
Asynchronicznie akceptuje wartość
MultiplayerInvitation i zwraca wynik za pomocą metody RealTimeRoomCallback . |
AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
Asynchronicznie akceptuje wartość
MultiplayerInvitation i zwraca wynik za pomocą metody RealTimeRoomCallback . |
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
Blokowanie wersji AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
Przeciążenie zasady AcceptInvitationBlocking, która ma domyślny limit czasu wynoszący 10 lat.
|
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
Blokowanie wersji AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
Przeciążenie zasady AcceptInvitationBlocking, która ma domyślny limit czasu wynoszący 10 lat.
|
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
Asynchronicznie tworzy obiekt
RealTimeRoom przy użyciu podanej klasy RealTimeRoomConfig . |
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
Asynchronicznie tworzy obiekt
RealTimeRoom przy użyciu podanej klasy RealTimeRoomConfig . |
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
Wersja blokująca CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
Przeciążenie reguły CreateRealTimeRoomBlocking, które ma domyślny limit czasu wynoszący 10 lat.
|
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
Wersja blokująca CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
Przeciążenie reguły CreateRealTimeRoomBlocking, które ma domyślny limit czasu wynoszący 10 lat.
|
DeclineInvitation(const MultiplayerInvitation & invitation)
|
void
Odrzuca wartość
MultiplayerInvitation na: RealTimeRoom . |
DismissInvitation(const MultiplayerInvitation & invitation)
|
void
Zamyka element
MultiplayerInvitation w elemencie RealTimeRoom . |
FetchInvitations(FetchInvitationsCallback callback)
|
void
Pobiera
MultiplayerInvitation na potrzeby pokoi w czasie rzeczywistym. |
FetchInvitationsBlocking(Timeout timeout)
|
Blokowanie wersji FetchInvitations.
|
FetchInvitationsBlocking()
|
Przeciążenie zasady FetchInvitationsBlocking o domyślnym czasie oczekiwania wynoszącym 10 lat.
|
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)
|
void
Opuszcza
RealTimeRoom . |
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)
|
Wersja blokująca pokój LeaveRoom.
|
LeaveRoomBlocking(const RealTimeRoom & room)
|
Przeciążenie zasady LeaveRoomBlocking, która ma domyślny limit czasu wynoszący 10 lat.
|
SendReliableMessage(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)
|
void
Wysyła wiadomość do określonego nadawcy (
MultiplayerParticipant ). |
SendReliableMessageBlocking(Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
Wersja blokująca SendReliableMessage.
|
SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
Przeciążenie mechanizmu SendReliableMessageBlocking, którego domyślny czas oczekiwania wynosi 10 lat.
|
SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
|
void
Wysyła wiadomość do określonych grup
MultiplayerParticipant . |
SendUnreliableMessageToOthers(const RealTimeRoom & room, std::vector< uint8_t > data)
|
void
Wysyła wiadomość do wszystkich uczestników oprócz bieżącego.
|
ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
|
void
Asynchronicznie pokazuje interfejs wyboru gracza, aby mógł on wybrać innych graczy, którzy dołączyli do pokoju.
|
ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
Wersja blokująca ShowPlayerSelectUI.
|
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
Przeciążenie zasady ShowPlayerSelectUIBlocking, które ma domyślny limit czasu wynoszący 10 lat.
|
ShowRoomInboxUI(RoomInboxUICallback callback)
|
void
Asynchronicznie pokazuje interfejs skrzynki odbiorczej pokoju, umożliwiając graczowi wybranie zaproszenia do gry wieloosobowej.
|
ShowRoomInboxUIBlocking(Timeout timeout)
|
Wersja blokująca ShowRoomInboxUI.
|
ShowRoomInboxUIBlocking()
|
Przeciążenie funkcji ShowRoomInboxUIBlocking, którego domyślny limit czasu wynosi 10 lat.
|
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
|
void
Interfejs poczekalni, w którym widać stan uczestników gry wieloosobowej dołączających do pokoju.
|
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
|
Wersja blokująca ShowWaitingRoomUI.
|
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)
|
Przeciążenie reguły ShowWaitingRoomUIBlocking, która ma domyślny limit czasu wynoszący 10 lat.
|
Struktura |
|
---|---|
gpg:: |
|
gpg:: |
|
gpg:: |
|
gpg:: |
|
Typy publiczne
FetchInvitationsCallback
std::function< void(const FetchInvitationsResponse &)> FetchInvitationsCallback
Określa wywołanie zwrotne, za pomocą którego można odebrać WaitingRoomUIResponse
z jednej z operacji multiplayer w czasie rzeczywistym.
LeaveRoomCallback
std::function< void(const ResponseStatus &)> LeaveRoomCallback
Definiuje wywołanie zwrotne, do którego można odebrać ResponseStatus
z urządzenia LeaveRoom
.
PlayerSelectUICallback
std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback
Definiuje wywołanie zwrotne, do którego można odebrać PlayerSelectUIResponse
z urządzenia ShowPlayerSelectUI
.
PlayerSelectUIResponse
TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse
Data
i ResponseStatus
dla operacji ShowPlayerSelectUI
.
Jest ona udostępniana w grze wieloosobowej turowej.
RealTimeRoomCallback
std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback
Definiuje wywołanie zwrotne, które może zostać użyte do otrzymania elementu struct RealTimeRoomResponse
z jednej z turowych operacji wieloosobowych.
RoomInboxUICallback
std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback
Definiuje wywołanie zwrotne, do którego można odebrać RoomInboxUIResponse
z urządzenia ShowRoomInboxUI
.
SendReliableMessageCallback
std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback
Definiuje wywołanie zwrotne, do którego można odebrać ResponseStatus
z urządzenia SendReliableMessage
.
WaitingRoomUICallback
std::function< void(const WaitingRoomUIResponse &)> WaitingRoomUICallback
Określa wywołanie zwrotne, za pomocą którego można odebrać WaitingRoomUIResponse
z jednej z operacji multiplayer w czasie rzeczywistym.
Funkcje publiczne
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
Asynchronicznie akceptuje wartość MultiplayerInvitation
i zwraca wynik za pomocą metody RealTimeRoomCallback
.
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
Asynchronicznie akceptuje wartość MultiplayerInvitation
i zwraca wynik za pomocą metody RealTimeRoomCallback
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
Blokowanie wersji AcceptInvitation.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
Przeciążenie zasady AcceptInvitationBlocking, która ma domyślny limit czasu wynoszący 10 lat.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
Blokowanie wersji AcceptInvitation.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
Przeciążenie zasady AcceptInvitationBlocking, która ma domyślny limit czasu wynoszący 10 lat.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
Asynchronicznie tworzy obiekt RealTimeRoom
przy użyciu podanej klasy RealTimeRoomConfig
.
Jeśli tworzenie się uda, funkcja zwróci obiekt RealTimeRoom
za pomocą podanej wartości RealTimeRoomCallback
.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
Asynchronicznie tworzy obiekt RealTimeRoom
przy użyciu podanej klasy RealTimeRoomConfig
.
Jeśli tworzenie się uda, funkcja zwróci obiekt RealTimeRoom
za pomocą podanej wartości RealTimeRoomCallback
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
Wersja blokująca CreateRealTimeRoom.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
Przeciążenie reguły CreateRealTimeRoomBlocking, które ma domyślny limit czasu wynoszący 10 lat.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
Wersja blokująca CreateRealTimeRoom.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
Przeciążenie reguły CreateRealTimeRoomBlocking, które ma domyślny limit czasu wynoszący 10 lat.
DeclineInvitation
void DeclineInvitation( const MultiplayerInvitation & invitation )
Odrzuca wartość MultiplayerInvitation
na: RealTimeRoom
.
Spowoduje to anulowanie pokoju dla innych uczestników i usunięcie go z urządzenia lokalnego gracza.
DismissInvitation
void DismissInvitation( const MultiplayerInvitation & invitation )
Zamyka element MultiplayerInvitation
w elemencie RealTimeRoom
.
Nie zmieni to stanu widoczności elementu RealTimeRoom
u pozostałych uczestników, ale zostanie usunięty z urządzenia lokalnego gracza.
FetchInvitations
void FetchInvitations( FetchInvitationsCallback callback )
Pobiera MultiplayerInvitation
na potrzeby pokoi w czasie rzeczywistym.
Pobrane elementy typu MultiplayerInvitation
są zwracane przez podaną wartość FetchInvitationsCallback
.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking( Timeout timeout )
Blokowanie wersji FetchInvitations.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie tego czasu funkcja zwróci wartość ERROR_TIMEOUT
.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking()
Przeciążenie zasady FetchInvitationsBlocking o domyślnym czasie oczekiwania wynoszącym 10 lat.
LeaveRoom
void LeaveRoom( const RealTimeRoom & room, LeaveRoomCallback callback )
Opuszcza RealTimeRoom
.
Do czasu zakończenia tej operacji nie twórz nowego pomieszczenia ani nie próbuj dołączyć do innego. Wynik tej operacji jest zwracany przez LeaveRoomCallback
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( Timeout timeout, const RealTimeRoom & room )
Wersja blokująca pokój LeaveRoom.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( const RealTimeRoom & room )
Przeciążenie zasady LeaveRoomBlocking, która ma domyślny limit czasu wynoszący 10 lat.
SendReliableMessage
void SendReliableMessage( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback )
Wysyła wiadomość do określonego nadawcy (MultiplayerParticipant
).
Używa niezawodnej metody wysyłania wiadomości. Ta metoda wysyłania danych może potrwać dłużej niż niestabilne wysłanie wiadomości. Rezultat wysłania jest zgłaszany przy użyciu podanego wywołania zwrotnego.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
Wersja blokująca SendReliableMessage.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
Przeciążenie reguły SendReliableMessageBlocking, która ma domyślny limit czasu wynoszący 10 lat.
SendUnreliableMessage
void SendUnreliableMessage( const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data )
Wysyła wiadomość do określonych grup MultiplayerParticipant
.
Przy wysyłaniu wiadomości używa zawodnej metody. Ta metoda wysyłania danych jest szybsza niż stabilne wysyłanie danych i powinna być preferowana, jeśli to możliwe.
SendUnreliableMessageToOthers
void SendUnreliableMessageToOthers( const RealTimeRoom & room, std::vector< uint8_t > data )
Wysyła wiadomość do wszystkich uczestników oprócz bieżącego.
Przy wysyłaniu wiadomości używa zawodnej metody. Ta metoda wysyłania danych jest szybsza niż stabilne wysyłanie danych i powinna być preferowana, jeśli to możliwe.
ShowPlayerSelectUI
void ShowPlayerSelectUI( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback )
Asynchronicznie pokazuje interfejs wyboru gracza, aby mógł on wybrać innych graczy, którzy dołączyli do pokoju.
Po ukończeniu gry wybrani gracze zostaną odesłani do PlayerSelectUICallback
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
Wersja blokująca ShowPlayerSelectUI.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
Przeciążenie zasady ShowPlayerSelectUIBlocking, które ma domyślny limit czasu wynoszący 10 lat.
ShowRoomInboxUI
void ShowRoomInboxUI( RoomInboxUICallback callback )
Asynchronicznie pokazuje interfejs skrzynki odbiorczej pokoju, umożliwiając graczowi wybranie zaproszenia do gry wieloosobowej.
Po zakończeniu wybrane zaproszenie jest zwracane przez RoomInboxUIResponse
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking( Timeout timeout )
Wersja blokująca ShowRoomInboxUI.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie określonego czasu funkcja zwraca ERROR_TIMEOUT
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking()
Przeciążenie funkcji ShowRoomInboxUIBlocking, którego domyślny limit czasu wynosi 10 lat.
ShowWaitingRoomUI
void ShowWaitingRoomUI( const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback )
Interfejs poczekalni, w którym widać stan uczestników gry wieloosobowej dołączających do pokoju.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start )
Wersja blokująca ShowWaitingRoomUI.
Zezwala wywołującemu na określenie limitu czasu w ms. Po upływie tego czasu funkcja zwróci wartość ERROR_TIMEOUT
.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( const RealTimeRoom & room, uint32_t min_participants_to_start )
Przeciążenie reguły ShowWaitingRoomUIBlocking, która ma domyślny limit czasu wynoszący 10 lat.