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 élément
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
MultiplayerParticipant . |
DisplayName() const
|
const std::string &
Nom à afficher pour ce
MultiplayerParticipant . |
HasMatchResult() const
|
bool
Indique si le participant a un résultat pour cette correspondance.
|
HasPlayer() const
|
bool
Indique si un Player est associé à ce
MultiplayerParticipant . |
Id() const
|
const std::string &
La valeur
Id de ce MultiplayerParticipant . |
IsConnectedToRoom() const
|
bool
Indique si ce participant est connecté à un
RealTimeRoom . |
MatchRank() const
|
uint32_t
Classement de cet élément (
MultiplayerParticipant ) dans sa correspondance. |
MatchResult() const
|
Résultat de la correspondance pour cet élément
MultiplayerParticipant . |
Player() const
|
Le lecteur associé à ce
MultiplayerParticipant . |
Status() const
|
État de cet élément
MultiplayerParticipant par rapport à la correspondance. |
Valid() const
|
bool
Renvoie "true" si cet
MultiplayerParticipant est renseigné avec des données. |
operator=(const MultiplayerParticipant & copy_from)
|
Attribue ce
MultiplayerParticipant en le copiant à partir d'un autre. |
operator=(MultiplayerParticipant && move_from)
|
Attribue ce
MultiplayerParticipant en y transférant une autre. |
Fonctions publiques
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
Renvoie l'URL où se trouve l'image de l'avatar de 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. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
DisplayName
const std::string & DisplayName() const
Nom à afficher pour ce MultiplayerParticipant
.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasMatchResult
bool HasMatchResult() const
Indique si le participant a un résultat pour cette correspondance.
Si la valeur est "false", MatchResult et MatchRank ne renvoient pas de données valides. La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
HasPlayer
bool HasPlayer() const
Indique si un Player est associé à ce MultiplayerParticipant
.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
ID
const std::string & Id() const
La valeur Id
de ce MultiplayerParticipant
.
Les éléments Id
ne sont valides que dans le cadre d'une seule correspondance et sont différents de ceux de Player::Id()
. La valeur Valide 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 cet élément (MultiplayerParticipant
) dans sa correspondance.
La valeur Valide 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 cet élément MultiplayerParticipant
.
La valeur Valide 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'un shared_ptr
vers un MultiplayerParticipantImpl
.
Destiné à un usage interne par l'API.
MultiplayerParticipant
MultiplayerParticipant( const MultiplayerParticipant & copy_from )
Crée une copie d'un élément MultiplayerParticipant
existant.
MultiplayerParticipant
MultiplayerParticipant( MultiplayerParticipant && move_from )
Déplace un élément MultiplayerParticipant
existant.
Joueur
gpg::Player Player() const
Le lecteur associé à ce MultiplayerParticipant
.
Valide et HasPlayer doivent tous les deux renvoyer la valeur "true" pour que cette fonction soit utilisable.
État
ParticipantStatus Status() const
État de cet élément MultiplayerParticipant
par rapport à la correspondance.
La valeur Valide doit renvoyer la valeur "true" pour que cette fonction soit utilisable.
Valide
bool Valid() const
Renvoie "true" si cet MultiplayerParticipant
est renseigné avec des données.
Doit être "true" pour que les fonctions getter (DisplayName
, AvatarUrl
, Id
, etc.) de ce MultiplayerParticipant
soient utilisables.
operator=
MultiplayerParticipant & operator=( const MultiplayerParticipant & copy_from )
Attribue ce MultiplayerParticipant
en le copiant à partir d'un autre.
operator=
MultiplayerParticipant & operator=( MultiplayerParticipant && move_from )
Attribue ce MultiplayerParticipant
en y transférant une autre.
~MultiplayerParticipant
~MultiplayerParticipant()