gpg::RealTimeRoom

#include <real_time_room.h>

Eine Datenstruktur, die den aktuellen Status eines Echtzeit-Mehrspielerraums enthält.

Zusammenfassung

Konstruktoren und Zerstörer

RealTimeRoom()
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
Konstruiert ein RealTimeRoom-Objekt aus einem shared_ptr- in ein RealTimeRoomImpl-Objekt.
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 servergenerierte Schätzung der Zeit, die benötigt wird, um die automatisch zugeordneten Slots für diesen Raum zu füllen.
CreatingParticipant() const
Gibt den Teilnehmer zurück, der diesen Chatroom erstellt hat.
CreationTime() const
std::chrono::milliseconds
Gibt den Zeitpunkt zurück, zu dem das RealTimeRoom-Objekt erstellt wurde (in Millisekunden seit der Unix-Epoche).
Description() const
std::string
Gibt eine vom Server generierte Zusammenfassung des Raumstatus 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 mit automatischer 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 wird.
Variant() const
uint32_t
Gibt eine spielspezifische Varianten-ID zurück, die in einem Spiel zur Identifizierung verschiedener Spielmodi verwendet werden kann.
operator=(const RealTimeRoom & copy_from)
Weist dieses RealTimeRoom-Objekt durch Kopieren aus einem anderen Objekt zu.
operator=(RealTimeRoom && move_from)
Weist dieses RealTimeRoom-Objekt zu, indem ein anderes dorthin verschoben wird.

Öffentliche Funktionen

AutomatchWaitEstimate

Timeout AutomatchWaitEstimate() const 

Eine servergenerierte Schätzung der Zeit, die benötigt wird, um die automatisch zugeordneten Slots für diesen Raum zu füllen.

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const 

Gibt den Teilnehmer zurück, der diesen Chatroom erstellt hat.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

CreationTime

std::chrono::milliseconds CreationTime() const 

Gibt den Zeitpunkt zurück, zu dem das RealTimeRoom-Objekt erstellt wurde (in Millisekunden seit der Unix-Epoche).

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Beschreibung

std::string Description() const 

Gibt eine vom Server generierte Zusammenfassung des Raumstatus zurück.

Für Valid muss „true“ zurückgegeben werden, 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 diesen Raum später abrufen möchten, verwenden Sie diese ID mit RealTimeRoom::FetchRoom.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Teilnehmer

std::vector< MultiplayerParticipant > Participants() const 

Ein Vektor aller Teilnehmer in diesem Raum.

Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

RealTimeRoom

 RealTimeRoom()

RealTimeRoom

 RealTimeRoom(
  std::shared_ptr< const RealTimeRoomImpl > impl
)

Konstruiert ein RealTimeRoom-Objekt aus einem shared_ptr- 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 mit automatischer Zuordnung für den Raum zurück

Diese Zahl entspricht der Anzahl der Slots, mit denen der Raum automatisch zugeordnet wurde, abzüglich der Anzahl der Teilnehmer, die bereits durch die automatische Zuordnung hinzugefügt wurden. Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Status

RealTimeRoomStatus Status() const 

Gibt den Status des Raums zurück

Der Status bestimmt, welche Aktionen für einen Chatroom ausgeführt werden können. Für Valid muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

Gültig

bool Valid() const 

Gibt „true“ zurück, wenn dieses RealTimeRoom-Objekt mit Daten gefüllt wird.

Muss „true“ zurückgeben, damit die Getter-Funktionen für das RealTimeRoom-Objekt (Id, CreationTime usw.) verwendet werden können.

Variante

uint32_t Variant() const 

Gibt eine spielspezifische Varianten-ID zurück, die in einem Spiel zur Identifizierung verschiedener Spielmodi verwendet werden kann.

Für Valid muss „true“ zurückgegeben werden, 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 dieses RealTimeRoom-Objekt zu, indem ein anderes dorthin verschoben wird.