gpg:: MultiplayerParticipant
#include <multiplayer_participant.h>
Structure de données contenant des données sur un participant à une partie multijoueur.
Résumé
Constructeurs et destructeurs |
|
---|---|
MultiplayerParticipant()
|
|
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
|
|
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
Crée une copie d'un
MultiplayerParticipant existant. |
|
MultiplayerParticipant(MultiplayerParticipant && move_from)
Déplace un élément
MultiplayerParticipant existant. |
|
~MultiplayerParticipant()
|
Fonctions publiques |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
Renvoie l'URL où se trouve l'image de l'avatar de cet
MultiplayerParticipant . |
DisplayName() const
|
const std::string &
Nom à afficher pour ce
MultiplayerParticipant . |
HasMatchResult() const
|
bool
Indique si ce participant a un résultat pour cette partie.
|
HasPlayer() const
|
bool
Indique si un Player est associé à ce
MultiplayerParticipant . |
Id() const
|
const std::string &
Le
Id de ce MultiplayerParticipant . |
IsConnectedToRoom() const
|
bool
Indique si ce participant est connecté à un
RealTimeRoom . |
MatchRank() const
|
uint32_t
Classement de ce
MultiplayerParticipant dans sa correspondance. |
MatchResult() const
|
Résultat de la correspondance pour ce
MultiplayerParticipant . |
Player() const
|
Le Player associé à ce
MultiplayerParticipant . |
Status() const
|
État de ce
MultiplayerParticipant par rapport à la correspondance. |
Valid() const
|
bool
Renvoie la valeur "true" si cet élément
MultiplayerParticipant est renseigné avec des données. |
operator=(const MultiplayerParticipant & copy_from)
|
Attribue ce
MultiplayerParticipant en copiant un autre élément. |
operator=(MultiplayerParticipant && move_from)
|
Attribue cet élément
MultiplayerParticipant en y déplaçant un autre élément. |
Fonctions publiques
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
Renvoie l'URL où se trouve l'image de l'avatar de cet MultiplayerParticipant
.
Le paramètre ImageResolution
spécifie la résolution de l'image renvoyée. Spécifiez ICON ou HI_RES pour la résolution. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
DisplayName
const std::string & DisplayName() const
Nom à afficher pour ce MultiplayerParticipant
.
Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasMatchResult
bool HasMatchResult() const
Indique si ce participant a un résultat pour cette partie.
Si la valeur est "false", MatchResult et MatchRank ne renvoient pas de données valides. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasPlayer
bool HasPlayer() const
Indique si un Player est associé à ce MultiplayerParticipant
.
Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
ID
const std::string & Id() const
Le Id
de ce MultiplayerParticipant
.
Les Id
ne sont valides que dans le cadre d'une seule correspondance et sont différents de Player::Id()
. Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
IsConnectedToRoom
bool IsConnectedToRoom() const
Indique si ce participant est connecté à un RealTimeRoom
.
Toujours "false" s'il s'agit d'un participant d'un TurnBasedMatch
.
MatchRank
uint32_t MatchRank() const
Classement de ce MultiplayerParticipant
dans sa correspondance.
Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable. Si HasMatchResult()
ne renvoie pas "true", cette fonction renvoie 0.
MatchResult
gpg::MatchResult MatchResult() const
Résultat de la correspondance pour ce MultiplayerParticipant
.
Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable. Si HasMatchResult()
ne renvoie pas la valeur "true", cette fonction renvoie MatchResult::None
.
MultiplayerParticipant
MultiplayerParticipant()
MultiplayerParticipant
MultiplayerParticipant( std::shared_ptr< const MultiplayerParticipantImpl > impl )
Construit un MultiplayerParticipant
à partir d'une shared_ptr
en MultiplayerParticipantImpl
.
Destiné à un usage interne par l'API.
MultiplayerParticipant
MultiplayerParticipant( const MultiplayerParticipant & copy_from )
Crée une copie d'un MultiplayerParticipant
existant.
MultiplayerParticipant
MultiplayerParticipant( MultiplayerParticipant && move_from )
Déplace un élément MultiplayerParticipant
existant.
Joueur
gpg::Player Player() const
Le Player associé à ce MultiplayerParticipant
.
Valid et HasPlayer doivent renvoyer la valeur "true" pour que cette fonction soit utilisable.
État
ParticipantStatus Status() const
État de ce MultiplayerParticipant
par rapport à la correspondance.
Valid doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Valide
bool Valid() const
Renvoie la valeur "true" si cet élément MultiplayerParticipant
est renseigné avec des données.
Doit être "true" pour que les fonctions getter (DisplayName
, AvatarUrl
, Id
, etc.) de ce MultiplayerParticipant
soient utilisables.
opérateur=
MultiplayerParticipant & operator=( const MultiplayerParticipant & copy_from )
Attribue ce MultiplayerParticipant
en copiant un autre élément.
opérateur=
MultiplayerParticipant & operator=( MultiplayerParticipant && move_from )
Attribue cet élément MultiplayerParticipant
en y déplaçant un autre élément.
~Participant multijoueur
~MultiplayerParticipant()