gpg::MultiplayerParticipant

#include <multiplayer_participant.h>

Uma estrutura de dados que contém dados sobre um participante em uma partida multiplayer.

Resumo

Construtores e destrutores
MultiplayerParticipant()
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
Cria um MultiplayerParticipant de um shared_ptr para um MultiplayerParticipantImpl.
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 do MultiplayerParticipant está armazenada.
DisplayName() const
const std::string &
O nome de exibição dessa MultiplayerParticipant.
HasMatchResult() const
bool
Indica se o participante tem um resultado para essa partida.
HasPlayer() const
bool
Indica se um jogador está associado a esse MultiplayerParticipant.
Id() const
const std::string &
IsConnectedToRoom() const
bool
Indica se o 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 jogador associado a essa MultiplayerParticipant.
Status() const
O status desta MultiplayerParticipant em relação à correspondência.
Valid() const
bool
Retorna verdadeiro se o MultiplayerParticipant for preenchido com dados.
operator=(const MultiplayerParticipant & copy_from)
Atribui essa MultiplayerParticipant copiando de outra.
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 do MultiplayerParticipant está armazenada.

O parâmetro ImageResolution especifica a resolução da imagem retornada. Especifique ICON ou HI_RES para a resolução. Valid precisa retornar verdadeiro para que essa função seja utilizável.

DisplayName

const std::string & DisplayName() const

O nome de exibição dessa MultiplayerParticipant.

Valid precisa retornar verdadeiro para que essa função seja utilizável.

HasMatchResult

bool HasMatchResult() const

Indica se o participante tem um resultado para essa partida.

Se for falso, MatchResult e MatchRank não vão retornar dados válidos. Valid precisa retornar verdadeiro para que essa função seja utilizável.

HasPlayer

bool HasPlayer() const

Indica se um jogador está associado a esse MultiplayerParticipant.

Valid precisa retornar verdadeiro para que essa função seja utilizável.

ID

const std::string & Id() const

O Id deste MultiplayerParticipant.

Os Ids são válidos apenas no escopo de uma única correspondência e são diferentes dos Player::Id()s. Valid precisa retornar verdadeiro para que essa função seja utilizável.

IsConnectedToRoom

bool IsConnectedToRoom() const

Indica se o 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 verdadeiro para que essa função seja utilizável. Se HasMatchResult() não retornar verdadeiro, essa função retornará 0.

MatchResult

gpg::MatchResult MatchResult() const

O resultado da correspondência para este MultiplayerParticipant.

Valid precisa retornar verdadeiro 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
)

Cria um MultiplayerParticipant de um shared_ptr para um MultiplayerParticipantImpl.

Destinado a uso interno pela 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 jogador associado a essa MultiplayerParticipant.

Valid e HasPlayer precisam retornar verdadeiro para que essa função seja utilizável.

Status

ParticipantStatus Status() const

O status desta MultiplayerParticipant em relação à correspondência.

Valid precisa retornar verdadeiro para que essa função seja utilizável.

Válido

bool Valid() const

Retorna verdadeiro se o MultiplayerParticipant for preenchido com dados.

Precisa ser verdadeiro para que as funções de getter (DisplayName, AvatarUrl, Id etc.) nesse MultiplayerParticipant sejam utilizáveis.

operator=

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

Atribui essa MultiplayerParticipant copiando de outra.

operator=

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

Atribui este MultiplayerParticipant movendo outro para ele.

~MultiplayerParticipant

 ~MultiplayerParticipant()