gpg::MultiplayerParticipant

#include <multiplayer_participant.h>

包含多人游戏匹配中参与者数据的结构。

概要

构造函数和析构函数
MultiplayerParticipant()
MultiplayerParticipant(std::shared_ptr< const MultiplayerParticipantImpl > impl)
从指向 MultiplayerParticipantImpl 的 shared_ptr 构造一个 MultiplayerParticipant。
MultiplayerParticipant(const MultiplayerParticipant & copy_from)
创建现有 MultiplayerParticipant 的副本。
MultiplayerParticipant(MultiplayerParticipant && move_from)
移动现有的 MultiplayerParticipant。
~MultiplayerParticipant()

公共函数
AvatarUrl(ImageResolution resolution) const
const std::string &
返回包含此 MultiplayerParticipant 头像图像的 URL。
DisplayName() const
const std::string &
此 MultiplayerParticipant 的显示名称。
HasMatchResult() const
bool
此参与者是否具有此匹配的结果。
HasPlayer() const
bool
是否将 Player 与此 MultiplayerParticipant 关联。
Id() const
const std::string &
IsConnectedToRoom() const
bool
此参与者是否连接到 RealTimeRoom。
MatchRank() const
uint32_t
此 MultiplayerParticipant 在其匹配中的排名。
MatchResult() const
此 MultiplayerParticipant 的匹配结果。
Player() const
与此 MultiplayerParticipant 关联的 Player。
Status() const
此 MultiplayerParticipant 相对于匹配的状态。
Valid() const
bool
如果此 MultiplayerParticipant 已填充数据，则返回 true。
operator=(const MultiplayerParticipant & copy_from)
通过从另一个 MultiplayerParticipant 复制来分配此 MultiplayerParticipant。
operator=(MultiplayerParticipant && move_from)
通过将另一个 MultiplayerParticipant 移动到其中来分配此 MultiplayerParticipant。

公共函数

AvatarUrl

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

返回包含此 MultiplayerParticipant 头像图像的 URL。

ImageResolution 参数指定返回图像的分辨率。指定 ICON 或 HI_RES 作为分辨率。要使用此函数，Valid 必须返回 true。

DisplayName

const std::string & DisplayName() const

此 MultiplayerParticipant 的显示名称。

要使用此函数，Valid 必须返回 true。

HasMatchResult

bool HasMatchResult() const

此参与者是否具有此匹配的结果。

如果为 false，则 MatchResult 和 MatchRank 不会返回有效数据。要使用此函数，Valid 必须返回 true。

HasPlayer

bool HasPlayer() const

是否将 Player 与此 MultiplayerParticipant 关联。

要使用此函数，Valid 必须返回 true。

Id

const std::string & Id() const

此 MultiplayerParticipant 的 Id。

Id 仅在单个匹配的范围内有效，并且不同于 Player::Id()。要使用此函数，Valid 必须返回 true。

IsConnectedToRoom

bool IsConnectedToRoom() const

此参与者是否连接到 RealTimeRoom。

如果这是来自 TurnBasedMatch 的参与者，则始终为 false。

MatchRank

uint32_t MatchRank() const

此 MultiplayerParticipant 在其匹配中的排名。

要使用此函数，Valid 必须返回 true。如果 HasMatchResult() 未返回 true，则此函数返回 0。

MatchResult

gpg::MatchResult MatchResult() const

此 MultiplayerParticipant 的匹配结果。

要使用此函数，Valid 必须返回 true。如果 HasMatchResult() 未返回 true，则此函数返回 MatchResult::None。

MultiplayerParticipant

 MultiplayerParticipant()

MultiplayerParticipant

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

从指向 MultiplayerParticipantImpl 的 shared_ptr 构造一个 MultiplayerParticipant。

供 API 内部使用。

MultiplayerParticipant

 MultiplayerParticipant(
  const MultiplayerParticipant & copy_from
)

创建现有 MultiplayerParticipant 的副本。

MultiplayerParticipant

 MultiplayerParticipant(
  MultiplayerParticipant && move_from
)

移动现有的 MultiplayerParticipant。

Player

gpg::Player Player() const

与此 MultiplayerParticipant 关联的 Player。

要使用此函数，Valid 和 HasPlayer 都必须返回 true。

Status

ParticipantStatus Status() const

此 MultiplayerParticipant 相对于匹配的状态。

要使用此函数，Valid 必须返回 true。

Valid

bool Valid() const

如果此 MultiplayerParticipant 已填充数据，则返回 true。

必须为 true，才能使用此 MultiplayerParticipant 上的 getter 函数（DisplayName、AvatarUrl、Id 等）。

operator=

MultiplayerParticipant & operator=(
  const MultiplayerParticipant & copy_from
)

通过从另一个 MultiplayerParticipant 复制来分配此 MultiplayerParticipant。

operator=

MultiplayerParticipant & operator=(
  MultiplayerParticipant && move_from
)

通过将另一个 MultiplayerParticipant 移动到其中来分配此 MultiplayerParticipant。

~MultiplayerParticipant

 ~MultiplayerParticipant()