гпг:: МультиплеерУчастник

#include <multiplayer_participant.h>

Структура данных, содержащая данные об участнике многопользовательского матча.

Краткое содержание

Конструкторы и деструкторы

MultiplayerParticipant ()
MultiplayerParticipant (std::shared_ptr< const MultiplayerParticipantImpl > impl)
Конструирует MultiplayerParticipant из shared_ptr в MultiplayerParticipantImpl .
MultiplayerParticipant (const MultiplayerParticipant & copy_from)
Создает копию существующего MultiplayerParticipant .
MultiplayerParticipant ( MultiplayerParticipant && move_from)
Перемещает существующий MultiplayerParticipant .
~MultiplayerParticipant ()

Общественные функции

AvatarUrl ( ImageResolution resolution) const
const std::string &
Возвращает URL-адрес, по которому находится изображение аватара этого MultiplayerParticipant .
DisplayName () const
const std::string &
Отображаемое имя для этого MultiplayerParticipant .
HasMatchResult () const
bool
Имеет ли этот участник результат на этот матч.
HasPlayer () const
bool
Связан ли Player с этим MultiplayerParticipant .
Id () const
const std::string &
Id этого MultiplayerParticipant .
IsConnectedToRoom () const
bool
Подключен ли этот участник к RealTimeRoom .
MatchRank () const
uint32_t
Ранг этого MultiplayerParticipant в матче.
MatchResult () const
Результат совпадения для этого MultiplayerParticipant .
Player () const
Игрок, связанный с этим MultiplayerParticipant .
Status () const
Статус этого MultiplayerParticipant относительно матча.
Valid () const
bool
Возвращает true, если этот MultiplayerParticipant заполнен данными.
operator= (const MultiplayerParticipant & copy_from)
Назначает этого MultiplayerParticipant путем копирования из другого.
operator= ( MultiplayerParticipant && move_from)
Назначает этого MultiplayerParticipant , перемещая в него еще одного.

Общественные функции

URL-адрес аватара 

const std::string & AvatarUrl(
  ImageResolution resolution
) const

Возвращает URL-адрес, по которому находится изображение аватара этого MultiplayerParticipant .

Параметр ImageResolution указывает разрешение возвращаемого изображения. Укажите разрешение ICON или HI_RES. Valid должен возвращать true, чтобы эту функцию можно было использовать.

Отображаемое имя 

const std::string & DisplayName() const

Отображаемое имя для этого MultiplayerParticipant .

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Хасматчрезультат 

bool HasMatchResult() const

Имеет ли этот участник результат на этот матч.

Если значение равно false, MatchResult и MatchRank не возвращают действительные данные. Valid должен возвращать true, чтобы эту функцию можно было использовать.

HasPlayer 

bool HasPlayer() const

Связан ли Player с этим MultiplayerParticipant .

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Идентификатор 

const std::string & Id() const

Id этого MultiplayerParticipant .

Id действительны только в пределах одного совпадения и отличаются от Player::Id() . Valid должен возвращать true, чтобы эту функцию можно было использовать.

Исконнектедторум 

bool IsConnectedToRoom() const

Подключен ли этот участник к RealTimeRoom .

Всегда false, если это участник TurnBasedMatch .

МатчРанг 

uint32_t MatchRank() const

Ранг этого MultiplayerParticipant в матче.

Valid должен возвращать true, чтобы эту функцию можно было использовать. Если HasMatchResult() не возвращает true, эта функция возвращает 0.

Результат матча 

gpg::MatchResult MatchResult() const

Результат совпадения для этого MultiplayerParticipant .

Valid должен возвращать true, чтобы эту функцию можно было использовать. Если HasMatchResult() не возвращает true, эта функция возвращает MatchResult::None .

МультиплеерУчастник 

 MultiplayerParticipant()

МультиплеерУчастник 

 MultiplayerParticipant(
  std::shared_ptr< const MultiplayerParticipantImpl > impl
)

Конструирует MultiplayerParticipant из shared_ptr в MultiplayerParticipantImpl .

Предназначен для внутреннего использования API.

МультиплеерУчастник 

 MultiplayerParticipant(
  const MultiplayerParticipant & copy_from
)

Создает копию существующего MultiplayerParticipant .

МультиплеерУчастник 

 MultiplayerParticipant(
  MultiplayerParticipant && move_from
)

Перемещает существующий MultiplayerParticipant .

Игрок 

gpg::Player Player() const

Игрок, связанный с этим MultiplayerParticipant .

Valid и HasPlayer должны возвращать true, чтобы эту функцию можно было использовать.

Статус 

ParticipantStatus Status() const

Статус этого MultiplayerParticipant относительно матча.

Valid должен возвращать true, чтобы эту функцию можно было использовать.

Действительный 

bool Valid() const

Возвращает true, если этот MultiplayerParticipant заполнен данными.

Должно быть истинно, чтобы функции получения ( DisplayName , AvatarUrl , Id и т. д.) в этом MultiplayerParticipant можно было использовать.

оператор= 

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

Назначает этого MultiplayerParticipant путем копирования из другого.

оператор= 

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

Назначает этого MultiplayerParticipant , перемещая в него еще одного.

~Участник мультиплеера 

 ~MultiplayerParticipant()