gpg:: MultiplayerParticipant
#include <multiplayer_participant.h>
Es una estructura de datos que contiene datos sobre un participante en una partida multijugador.
Resumen
Constructores y destructores |
|
---|---|
MultiplayerParticipant()
|
|
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
|
|
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
Crea una copia de un
MultiplayerParticipant existente. |
|
MultiplayerParticipant(MultiplayerParticipant && move_from)
Mueve un
MultiplayerParticipant existente. |
|
~MultiplayerParticipant()
|
Funciones públicas |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
Muestra la URL en la que reside la imagen del avatar de este
MultiplayerParticipant . |
DisplayName() const
|
const std::string &
Es el nombre visible de este
MultiplayerParticipant . |
HasMatchResult() const
|
bool
Indica si este participante tiene un resultado para esta coincidencia.
|
HasPlayer() const
|
bool
Indica si un jugador está asociado con este
MultiplayerParticipant . |
Id() const
|
const std::string &
Es el
Id de este MultiplayerParticipant . |
IsConnectedToRoom() const
|
bool
Indica si este participante está conectado a un
RealTimeRoom . |
MatchRank() const
|
uint32_t
Es la clasificación de este
MultiplayerParticipant dentro de su coincidencia. |
MatchResult() const
|
Es el resultado de la coincidencia para este
MultiplayerParticipant . |
Player() const
|
El reproductor asociado con este
MultiplayerParticipant . |
Status() const
|
Es el estado de este
MultiplayerParticipant con respecto a la coincidencia. |
Valid() const
|
bool
Muestra verdadero si este
MultiplayerParticipant se propaga con datos. |
operator=(const MultiplayerParticipant & copy_from)
|
Asigna este
MultiplayerParticipant copiando de otro. |
operator=(MultiplayerParticipant && move_from)
|
Asigna este
MultiplayerParticipant moviendo otro dentro de él. |
Funciones públicas
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
Muestra la URL en la que reside la imagen del avatar de este MultiplayerParticipant
.
El parámetro ImageResolution
especifica la resolución de la imagen que se muestra. Especifica ICON o HI_RES para la resolución. Valid debe mostrar verdadero para que esta función se pueda usar.
DisplayName
const std::string & DisplayName() const
Es el nombre visible de este MultiplayerParticipant
.
Valid debe mostrar verdadero para que esta función se pueda usar.
HasMatchResult
bool HasMatchResult() const
Indica si este participante tiene un resultado para esta coincidencia.
Si es falso, MatchResult y MatchRank no muestran datos válidos. Valid debe mostrar verdadero para que esta función se pueda usar.
HasPlayer
bool HasPlayer() const
Indica si un jugador está asociado con este MultiplayerParticipant
.
Valid debe mostrar verdadero para que esta función se pueda usar.
ID
const std::string & Id() const
Es el Id
de este MultiplayerParticipant
.
Los Id
solo son válidos en el alcance de una sola coincidencia y son diferentes de los Player::Id()
. Valid debe mostrar verdadero para que esta función se pueda usar.
IsConnectedToRoom
bool IsConnectedToRoom() const
Indica si este participante está conectado a un RealTimeRoom
.
Siempre es falso si se trata de un participante de un TurnBasedMatch
.
MatchRank
uint32_t MatchRank() const
Es la clasificación de este MultiplayerParticipant
dentro de su coincidencia.
Valid debe mostrar verdadero para que esta función se pueda usar. Si HasMatchResult()
no muestra un valor verdadero, esta función muestra 0.
MatchResult
gpg::MatchResult MatchResult() const
Es el resultado de la coincidencia para este MultiplayerParticipant
.
Valid debe mostrar verdadero para que esta función se pueda usar. Si HasMatchResult()
no muestra un valor verdadero, esta función muestra MatchResult::None
.
MultiplayerParticipant
MultiplayerParticipant()
MultiplayerParticipant
MultiplayerParticipant( std::shared_ptr< const MultiplayerParticipantImpl > impl )
Construye un MultiplayerParticipant
de un shared_ptr
a un MultiplayerParticipantImpl
.
Está destinado al uso interno de la API.
MultiplayerParticipant
MultiplayerParticipant( const MultiplayerParticipant & copy_from )
Crea una copia de un MultiplayerParticipant
existente.
MultiplayerParticipant
MultiplayerParticipant( MultiplayerParticipant && move_from )
Mueve un MultiplayerParticipant
existente.
Jugador
gpg::Player Player() const
El reproductor asociado con este MultiplayerParticipant
.
Valid y HasPlayer deben mostrar un valor verdadero para que se pueda usar esta función.
Estado
ParticipantStatus Status() const
Es el estado de este MultiplayerParticipant
con respecto a la coincidencia.
Valid debe mostrar verdadero para que esta función se pueda usar.
Válido
bool Valid() const
Muestra verdadero si este MultiplayerParticipant
se propaga con datos.
Debe ser verdadero para que se puedan usar las funciones de obtención (DisplayName
, AvatarUrl
, Id
, etc.) en este MultiplayerParticipant
.
operador=
MultiplayerParticipant & operator=( const MultiplayerParticipant & copy_from )
Asigna este MultiplayerParticipant
copiando de otro.
operador=
MultiplayerParticipant & operator=( MultiplayerParticipant && move_from )
Asigna este MultiplayerParticipant
moviendo otro dentro de él.
~MultiplayerParticipant
~MultiplayerParticipant()