gpg:: RealTimeRoom
#include <real_time_room.h>
Struktura danych zawierająca bieżący stan pokoju wieloosobowego w czasie rzeczywistym.
Podsumowanie
Konstruktory i niszczyciele |
|
---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
Tworzy kopię istniejącego obiektu
RealTimeRoom . |
|
RealTimeRoom(RealTimeRoom && move_from)
Przenosi istniejący obiekt
RealTimeRoom . |
Funkcje publiczne |
|
---|---|
AutomatchWaitEstimate() const
|
Wygenerowany przez serwer szacunkowy czas potrzebny na wypełnienie przedziałów automatycznego dopasowywania tej sali.
|
CreatingParticipant() const
|
Zwraca uczestnika, który utworzył ten pokój.
|
CreationTime() const
|
std::chrono::milliseconds
Zwraca czas utworzenia obiektu
RealTimeRoom (wyrażony w milisekundach od początku epoki uniksowej). |
Description() const
|
std::string
Zwraca wygenerowane przez serwer podsumowanie stanu sali.
|
Id() const
|
const std::string &
Zwraca identyfikator, który jednoznacznie identyfikuje ten obiekt
RealTimeRoom . |
Participants() const
|
std::vector< MultiplayerParticipant >
Wektor określający wszystkich uczestników w tym pokoju.
|
RemainingAutomatchingSlots() const
|
uint32_t
Zwraca liczbę dostępnych automatycznie dopasowanych przedziałów dla sali.
|
Status() const
|
Zwraca stan pokoju.
|
Valid() const
|
bool
Zwraca wartość „prawda”, jeśli ten obiekt
RealTimeRoom jest wypełniony danymi. |
Variant() const
|
uint32_t
Zwraca identyfikator wariantu gry, który może służyć do identyfikowania różnych trybów gry.
|
operator=(const RealTimeRoom & copy_from)
|
Przypisuje ten obiekt
RealTimeRoom , kopiując go z innego. |
operator=(RealTimeRoom && move_from)
|
Przypisuje ten obiekt
RealTimeRoom , przenosząc do niego inny obiekt. |
Funkcje publiczne
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
Wygenerowany przez serwer szacunkowy czas potrzebny na wypełnienie przedziałów automatycznego dopasowywania tej sali.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Zwraca uczestnika, który utworzył ten pokój.
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
CreationTime
std::chrono::milliseconds CreationTime() const
Zwraca czas utworzenia obiektu RealTimeRoom
(wyrażony w milisekundach od początku epoki uniksowej).
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
Opis
std::string Description() const
Zwraca wygenerowane przez serwer podsumowanie stanu sali.
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
Identyfikator
const std::string & Id() const
Zwraca identyfikator, który jednoznacznie identyfikuje ten obiekt RealTimeRoom
.
Aby później odzyskać ten pokój, użyj tego identyfikatora w usłudze RealTimeRoom::FetchRoom
.
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
Uczestnicy
std::vector< MultiplayerParticipant > Participants() const
Wektor określający wszystkich uczestników w tym pokoju.
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
Konstruuje obiekt RealTimeRoom
z shared_ptr
do RealTimeRoomImpl
.
Przeznaczony do użytku wewnętrznego w interfejsie API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Tworzy kopię istniejącego obiektu RealTimeRoom
.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Zwraca liczbę dostępnych automatycznie dopasowanych przedziałów dla sali.
Liczba ta jest równa liczbie przedziałów z automatycznym dopasowywaniem, w których pokój został utworzony, pomniejszony o liczbę uczestników, którzy zostali już dodani za pomocą automatycznego dopasowywania. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
Stan
RealTimeRoomStatus Status() const
Zwraca stan pokoju.
Stan określa, jakie działania można wykonać w pokoju. Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
Prawidłowe
bool Valid() const
Zwraca wartość „prawda”, jeśli ten obiekt RealTimeRoom
jest wypełniony danymi.
Aby funkcje pobierania w obiekcie RealTimeRoom
(Id
, CreationTime
itd.) mogły być użyte, musi zwracać wartość „true” (prawda).
Wariant
uint32_t Variant() const
Zwraca identyfikator wariantu gry, który może służyć do identyfikowania różnych trybów gry.
Aby można było używać tej funkcji, Valid musi zwracać wartość „true” (prawda).
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
Przypisuje ten obiekt RealTimeRoom
, kopiując go z innego.
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
Przypisuje ten obiekt RealTimeRoom
, przenosząc do niego inny obiekt.