gpg::MultiplayerInvitation

#include <multiplayer_invitation.h>

一个数据结构，包含有关回合制比赛邀请当前状态的数据。

摘要

构造函数和析构函数
MultiplayerInvitation()
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
从指向 TurnBasedMatchImpl 的 shared_ptr 构造 MultiplayerInvitation。
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
从指向 RealTimeRoomImpl 的 shared_ptr 构造 MultiplayerInvitation。
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
创建现有 MultiplayerInvitation 的副本。
MultiplayerInvitation(MultiplayerInvitation && move_from)
将现有 MultiplayerInvitation 移动到新对象中。

公共函数
AutomatchingSlotsAvailable() const
uint32_t
返回此对象所属比赛的可用自动匹配槽数量（此对象是该比赛的邀请）。
CreationTime() const
返回此邀请所属 TurnBasedMatch 的创建时间（以 Unix 纪元以来的毫秒表示）。
Id() const
const std::string &
返回唯一标识此 MultiplayerInvitation 的 ID。
InvitingParticipant() const
返回邀请本地参与者加入此邀请所属 TurnBasedMatch 的参与者。
Participants() const
const std::vector< MultiplayerParticipant > &
此邀请所属 TurnBasedMatch 中的所有参与者向量。
Type() const
标识此邀请是针对 RealTimeRoom 还是 TurnBasedMatch。
Valid() const
bool
如果此 MultiplayerInvitation 包含数据，则返回 true。
Variant() const
uint32_t
返回游戏可用于识别游戏模式的特定于游戏的变体标识符。
operator=(const MultiplayerInvitation & copy_from)
通过从另一个 MultiplayerInvitation 复制来为此对象赋值。
operator=(MultiplayerInvitation && move_from)
通过将另一个 MultiplayerInvitation 移动到此对象来为其赋值。

公共函数

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

返回此对象所属比赛的可用自动匹配槽数量（此对象是该比赛的邀请）。

此值等于创建比赛时设置的自动匹配槽数量减去已通过自动匹配添加的参与者数量。若要使用此函数，Valid 必须返回 true。

CreationTime

Timestamp CreationTime() const

返回此邀请所属 TurnBasedMatch 的创建时间（以 Unix 纪元以来的毫秒表示）。

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

Id

const std::string & Id() const

返回唯一标识此 MultiplayerInvitation 的 ID。

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

InvitingParticipant

MultiplayerParticipant InvitingParticipant() const

返回邀请本地参与者加入此邀请所属 TurnBasedMatch 的参与者。

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

MultiplayerInvitation

 MultiplayerInvitation()

MultiplayerInvitation

 MultiplayerInvitation(
  std::shared_ptr< const TurnBasedMatchImpl > impl
)

从指向 TurnBasedMatchImpl 的 shared_ptr 构造 MultiplayerInvitation。

供 API 内部使用。

MultiplayerInvitation

 MultiplayerInvitation(
  std::shared_ptr< const RealTimeRoomImpl > impl
)

从指向 RealTimeRoomImpl 的 shared_ptr 构造 MultiplayerInvitation。

供 API 内部使用。

MultiplayerInvitation

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

创建现有 MultiplayerInvitation 的副本。

MultiplayerInvitation

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

将现有 MultiplayerInvitation 移动到新对象中。

Participants

const std::vector< MultiplayerParticipant > & Participants() const

此邀请所属 TurnBasedMatch 中的所有参与者向量。

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

Type

MultiplayerInvitationType Type() const

标识此邀请是针对 RealTimeRoom 还是 TurnBasedMatch。

Valid

bool Valid() const

如果此 MultiplayerInvitation 包含数据，则返回 true。

必须为 true，才能使用此 MultiplayerInvitation 对象上的 getter 函数（Id、Variant 等）。

Variant

uint32_t Variant() const

返回游戏可用于识别游戏模式的特定于游戏的变体标识符。

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

operator=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

通过从另一个 MultiplayerInvitation 复制来为此对象赋值。

operator=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

通过将另一个 MultiplayerInvitation 移动到此对象来为其赋值。