gpg::
#include <real_time_room.h>
Datenstruktur, die den aktuellen Status eines Echtzeit-Mehrspielerraums enthält.
Zusammenfassung
Konstruktoren und Zerstörer |
|
|---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
Erstellt eine Kopie eines vorhandenen
RealTimeRoom-Objekts. |
|
RealTimeRoom(RealTimeRoom && move_from)
Verschiebt ein vorhandenes
RealTimeRoom-Objekt. |
Öffentliche Funktionen |
|
|---|---|
AutomatchWaitEstimate() const
|
Eine vom Server generierte Schätzung der Zeit, die benötigt wird, um die automatisch zugeordneten Slots dieses Raums zu füllen.
|
CreatingParticipant() const
|
Gibt den Teilnehmer zurück, der diesen Raum erstellt hat
|
CreationTime() const
|
std::chrono::milliseconds
Gibt den Zeitpunkt zurück, zu dem dieses
RealTimeRoom-Objekt erstellt wurde (ausgedrückt als Millisekunden seit der Unix-Epoche). |
Description() const
|
std::string
Gibt eine vom Server generierte Zusammenfassung des Status des Raums zurück.
|
Id() const
|
const std::string &
Gibt eine ID zurück, die dieses
RealTimeRoom-Objekt eindeutig identifiziert. |
Participants() const
|
std::vector< MultiplayerParticipant >
Ein Vektor aller Teilnehmer in diesem Raum.
|
RemainingAutomatchingSlots() const
|
uint32_t
Gibt die Anzahl der verfügbaren Slots für die automatische Zuordnung für den Raum zurück.
|
Status() const
|
Gibt den Status des Raums zurück
|
Valid() const
|
bool
Gibt „true“ zurück, wenn dieses
RealTimeRoom-Objekt mit Daten gefüllt ist. |
Variant() const
|
uint32_t
Gibt eine spielspezifische Varianten-ID zurück, die von einem Spiel verwendet werden kann, um verschiedene Spielmodi zu identifizieren.
|
operator=(const RealTimeRoom & copy_from)
|
Weist dieses
RealTimeRoom-Objekt durch Kopieren aus einem anderen Objekt zu. |
operator=(RealTimeRoom && move_from)
|
Weist diesem
RealTimeRoom-Objekt zu, indem ein anderes in das Objekt verschoben wird. |
Öffentliche Funktionen
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
Eine vom Server generierte Schätzung der Zeit, die benötigt wird, um die automatisch zugeordneten Slots dieses Raums zu füllen.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Gibt den Teilnehmer zurück, der diesen Raum erstellt hat
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
CreationTime
std::chrono::milliseconds CreationTime() const
Gibt den Zeitpunkt zurück, zu dem dieses RealTimeRoom-Objekt erstellt wurde (ausgedrückt als Millisekunden seit der Unix-Epoche).
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
Beschreibung
std::string Description() const
Gibt eine vom Server generierte Zusammenfassung des Status des Raums zurück.
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
ID
const std::string & Id() const
Gibt eine ID zurück, die dieses RealTimeRoom-Objekt eindeutig identifiziert.
Wenn Sie den Raum später abrufen möchten, verwenden Sie diese ID mit RealTimeRoom::FetchRoom.
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
Teilnehmer
std::vector< MultiplayerParticipant > Participants() const
Ein Vektor aller Teilnehmer in diesem Raum.
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
Konstruiert ein RealTimeRoom-Objekt aus einem shared_ptr-Element in ein RealTimeRoomImpl-Objekt.
Vorgesehen für die interne Verwendung durch die API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Erstellt eine Kopie eines vorhandenen RealTimeRoom-Objekts.
RealTimeRoom
RealTimeRoom( RealTimeRoom && move_from )
Verschiebt ein vorhandenes RealTimeRoom-Objekt.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Gibt die Anzahl der verfügbaren Slots für die automatische Zuordnung für den Raum zurück.
Diese Anzahl entspricht der Anzahl der automatisch passenden Slots, mit denen der Raum erstellt wurde, abzüglich der Anzahl der Teilnehmer, die bereits durch die automatische Zuordnung hinzugefügt wurden. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
Status
RealTimeRoomStatus Status() const
Gibt den Status des Raums zurück
Mit dem Status wird festgelegt, welche Aktionen für einen Chatroom möglich sind. Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
Gültig
bool Valid() const
Gibt „true“ zurück, wenn dieses RealTimeRoom-Objekt mit Daten gefüllt ist.
Damit die Getter-Funktionen im RealTimeRoom-Objekt (Id, CreationTime usw.) verwendet werden können, muss „true“ zurückgegeben werden.
Variante
uint32_t Variant() const
Gibt eine spielspezifische Varianten-ID zurück, die von einem Spiel verwendet werden kann, um verschiedene Spielmodi zu identifizieren.
Valid muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
Weist dieses RealTimeRoom-Objekt durch Kopieren aus einem anderen Objekt zu.
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
Weist diesem RealTimeRoom-Objekt zu, indem ein anderes in das Objekt verschoben wird.