gpg::
#include <real_time_room.h>
Structure de données contenant l'état actuel d'une salle multijoueur en temps réel.
Résumé
Constructeurs et destructeurs |
|
|---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
RealTimeRoom(const RealTimeRoom & copy_from)
Crée une copie d'un objet
RealTimeRoom existant. |
|
RealTimeRoom(RealTimeRoom && move_from)
Déplace un objet
RealTimeRoom existant. |
Fonctions publiques |
|
|---|---|
AutomatchWaitEstimate() const
|
Estimation, générée par le serveur, du temps nécessaire pour remplir les créneaux correspondant automatiquement à cette salle.
|
CreatingParticipant() const
|
Renvoie le participant qui a créé cette salle.
|
CreationTime() const
|
std::chrono::milliseconds
Renvoie l'heure à laquelle cet objet
RealTimeRoom a été créé (exprimée en millisecondes depuis l'époque Unix). |
Description() const
|
std::string
Renvoie un résumé généré par le serveur de l'état de la salle.
|
Id() const
|
const std::string &
Renvoie un ID qui identifie cet objet
RealTimeRoom de manière unique. |
Participants() const
|
std::vector< MultiplayerParticipant >
Vecteur de tous les participants de cette salle.
|
RemainingAutomatchingSlots() const
|
uint32_t
Renvoie le nombre d'emplacements avec correspondance automatique disponibles pour la salle.
|
Status() const
|
Affiche l'état de la salle.
|
Valid() const
|
bool
Renvoie la valeur "true" si cet objet
RealTimeRoom est renseigné avec des données. |
Variant() const
|
uint32_t
Renvoie un identifiant de variante spécifique au jeu, qui peut être utilisé par un jeu pour identifier différents modes de jeu.
|
operator=(const RealTimeRoom & copy_from)
|
Attribue cet objet
RealTimeRoom en le copiant à partir d'un autre. |
operator=(RealTimeRoom && move_from)
|
Attribue cet objet
RealTimeRoom en y déplaçant un autre objet. |
Fonctions publiques
AutomatchWaitEstimate
Timeout AutomatchWaitEstimate() const
Estimation, générée par le serveur, du temps nécessaire pour remplir les créneaux correspondant automatiquement à cette salle.
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
Renvoie le participant qui a créé cette salle.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
CreationTime
std::chrono::milliseconds CreationTime() const
Renvoie l'heure à laquelle cet objet RealTimeRoom a été créé (exprimée en millisecondes depuis l'époque Unix).
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Description
std::string Description() const
Renvoie un résumé généré par le serveur de l'état de la salle.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
ID
const std::string & Id() const
Renvoie un ID qui identifie cet objet RealTimeRoom de manière unique.
Pour récupérer cette salle ultérieurement, utilisez cet ID avec RealTimeRoom::FetchRoom.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Participants
std::vector< MultiplayerParticipant > Participants() const
Vecteur de tous les participants de cette salle.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
Construit un objet RealTimeRoom à partir d'un objet shared_ptr vers un objet RealTimeRoomImpl.
Destiné à un usage interne par l'API.
RealTimeRoom
RealTimeRoom( const RealTimeRoom & copy_from )
Crée une copie d'un objet RealTimeRoom existant.
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
Renvoie le nombre d'emplacements avec correspondance automatique disponibles pour la salle.
Ce nombre est égal au nombre d'emplacements avec correspondance automatique avec lesquels la salle a été créée, moins le nombre de participants qui ont déjà été ajoutés via cette fonctionnalité. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
État
RealTimeRoomStatus Status() const
Affiche l'état de la salle.
L'état détermine les actions qui peuvent être effectuées sur une salle. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Valide
bool Valid() const
Renvoie la valeur "true" si cet objet RealTimeRoom est renseigné avec des données.
Doit renvoyer "true" pour que les fonctions getter de l'objet RealTimeRoom (Id, CreationTime, etc.) soient utilisables.
Variant
uint32_t Variant() const
Renvoie un identifiant de variante spécifique au jeu, qui peut être utilisé par un jeu pour identifier différents modes de jeu.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
Attribue cet objet RealTimeRoom en le copiant à partir d'un autre.
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
Attribue cet objet RealTimeRoom en y déplaçant un autre objet.