gpg:: MultiplayerParticipant
#include <multiplayer_participant.h>
Uma estrutura de dados que contém dados sobre um participante de uma partida multiplayer.
Resumo
Construtores e destrutores |
|
---|---|
MultiplayerParticipant()
|
|
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
|
|
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
Cria uma cópia de um
MultiplayerParticipant existente. |
|
MultiplayerParticipant(MultiplayerParticipant && move_from)
Move um
MultiplayerParticipant existente. |
|
~MultiplayerParticipant()
|
Funções públicas |
|
---|---|
AvatarUrl(ImageResolution resolution) const
|
const std::string &
Retorna o URL em que a imagem do avatar de
MultiplayerParticipant está. |
DisplayName() const
|
const std::string &
O nome de exibição desse
MultiplayerParticipant . |
HasMatchResult() const
|
bool
Se este participante tem um resultado para esta correspondência.
|
HasPlayer() const
|
bool
Se um Player está associado a esse
MultiplayerParticipant . |
Id() const
|
const std::string &
O
Id deste MultiplayerParticipant . |
IsConnectedToRoom() const
|
bool
Se este participante está conectado a um
RealTimeRoom . |
MatchRank() const
|
uint32_t
A classificação desse
MultiplayerParticipant na correspondência. |
MatchResult() const
|
O resultado da correspondência para este
MultiplayerParticipant . |
Player() const
|
O Player associado a esse
MultiplayerParticipant . |
Status() const
|
O status deste
MultiplayerParticipant em relação à correspondência. |
Valid() const
|
bool
Retorna verdadeiro se
MultiplayerParticipant for preenchido com dados. |
operator=(const MultiplayerParticipant & copy_from)
|
Atribui este
MultiplayerParticipant copiando de outro. |
operator=(MultiplayerParticipant && move_from)
|
Atribui este
MultiplayerParticipant movendo outro para ele. |
Funções públicas
AvatarUrl
const std::string & AvatarUrl( ImageResolution resolution ) const
Retorna o URL em que a imagem do avatar de MultiplayerParticipant
está.
O parâmetro ImageResolution
especifica a resolução da imagem retornada. Especifique ICON ou HI_RES para a resolução. Valid precisa retornar true para que essa função seja utilizável.
DisplayName
const std::string & DisplayName() const
O nome de exibição desse MultiplayerParticipant
.
Valid precisa retornar true para que essa função seja utilizável.
HasMatchResult
bool HasMatchResult() const
Se este participante tem um resultado para esta correspondência.
Se for falso, MatchResult e MatchRank não retornarão dados válidos. Valid precisa retornar true para que essa função seja utilizável.
HasPlayer
bool HasPlayer() const
Se um Player está associado a esse MultiplayerParticipant
.
Valid precisa retornar true para que essa função seja utilizável.
ID
const std::string & Id() const
O Id
deste MultiplayerParticipant
.
Id
s são válidos apenas no escopo de uma única correspondência e são diferentes dos Player::Id()
. Valid precisa retornar true para que essa função seja utilizável.
IsConnectedToRoom
bool IsConnectedToRoom() const
Se este participante está conectado a um RealTimeRoom
.
Sempre falso se for um participante de uma TurnBasedMatch
.
MatchRank
uint32_t MatchRank() const
A classificação desse MultiplayerParticipant
na correspondência.
Valid precisa retornar true para que essa função seja utilizável. Se HasMatchResult()
não retornar "true", essa função vai retornar 0.
MatchResult
gpg::MatchResult MatchResult() const
O resultado da correspondência para este MultiplayerParticipant
.
Valid precisa retornar true para que essa função seja utilizável. Se HasMatchResult()
não retornar verdadeiro, essa função retornará MatchResult::None
.
MultiplayerParticipant
MultiplayerParticipant()
MultiplayerParticipant
MultiplayerParticipant( std::shared_ptr< const MultiplayerParticipantImpl > impl )
Constrói um MultiplayerParticipant
de um shared_ptr
a um MultiplayerParticipantImpl
.
Destinado ao uso interno da API.
MultiplayerParticipant
MultiplayerParticipant( const MultiplayerParticipant & copy_from )
Cria uma cópia de um MultiplayerParticipant
existente.
MultiplayerParticipant
MultiplayerParticipant( MultiplayerParticipant && move_from )
Move um MultiplayerParticipant
existente.
Jogador
gpg::Player Player() const
O Player associado a esse MultiplayerParticipant
.
Valid e HasPlayer precisam retornar true para que essa função seja utilizável.
Status
ParticipantStatus Status() const
O status deste MultiplayerParticipant
em relação à correspondência.
Valid precisa retornar true para que essa função seja utilizável.
Válida
bool Valid() const
Retorna verdadeiro se MultiplayerParticipant
for preenchido com dados.
Precisa ser verdadeiro para que as funções getter (DisplayName
, AvatarUrl
, Id
etc.) neste MultiplayerParticipant
possam ser usadas.
operador=
MultiplayerParticipant & operator=( const MultiplayerParticipant & copy_from )
Atribui este MultiplayerParticipant
copiando de outro.
operador=
MultiplayerParticipant & operator=( MultiplayerParticipant && move_from )
Atribui este MultiplayerParticipant
movendo outro para ele.
~Multiplayer participante
~MultiplayerParticipant()