gpg::MultiplayerInvitation

#include <multiplayer_invitation.h>

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

摘要

构造函数和析构函数
MultiplayerInvitation()
MultiplayerInvitation(std::shared_ptr< const TurnBasedMatchImpl > impl)
从 shared_ptr 到 TurnBasedMatchImpl 构建 MultiplayerInvitation。
MultiplayerInvitation(std::shared_ptr< const RealTimeRoomImpl > impl)
从 shared_ptr 到 RealTimeRoomImpl 构建 MultiplayerInvitation。
MultiplayerInvitation(const MultiplayerInvitation & copy_from)
创建现有 MultiplayerInvitation 的副本。
MultiplayerInvitation(MultiplayerInvitation && move_from)

公共函数
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)
通过从另一个多人游戏邀请复制来分配此多人游戏邀请。
operator=(MultiplayerInvitation && move_from)
通过将另一个 MultiplayerInvitation 移入此 MultiplayerInvitation 来分配此 MultiplayerInvitation。

公共函数

AutomatchingSlotsAvailable

uint32_t AutomatchingSlotsAvailable() const

返回此对象为邀请对象的匹配的可用自动匹配槽数。

此值等于用于创建匹配的自动匹配槽位数减去已通过自动匹配添加的参与者数量。有效必须返回 true，此函数才能使用。

CreationTime

Timestamp CreationTime() const

返回为此邀请创建 TurnBasedMatch 的时间（以自 Unix 纪元开始算起的毫秒数表示）。

有效必须返回 true，此函数才能使用。

ID

const std::string & Id() const

返回用于唯一标识此 MultiplayerInvitation 的 ID。

有效必须返回 true，此函数才能使用。

InvitingParticipant

MultiplayerParticipant InvitingParticipant() const

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

有效必须返回 true，此函数才能使用。

MultiplayerInvitation

 MultiplayerInvitation()

MultiplayerInvitation

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

从 shared_ptr 到 TurnBasedMatchImpl 构建 MultiplayerInvitation。

供 API 内部使用。

MultiplayerInvitation

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

将 shared_ptr 构建为 RealTimeRoomImpl 的 MultiplayerInvitation。

供 API 内部使用。

MultiplayerInvitation

 MultiplayerInvitation(
  const MultiplayerInvitation & copy_from
)

创建现有 MultiplayerInvitation 的副本。

MultiplayerInvitation

 MultiplayerInvitation(
  MultiplayerInvitation && move_from
)

将现有的 MultiplayerInvitation 移至新 MultiplayerInvitation。

参与者

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

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

有效必须返回 true，此函数才能使用。

类型

MultiplayerInvitationType Type() const

用于确定此邀请是针对 RealTimeRoom 还是 TurnBasedMatch。

有效

bool Valid() const

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

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

变体

uint32_t Variant() const

返回游戏专用变体标识符，游戏可以使用该标识符来标识游戏模式。

有效必须返回 true，此函数才能使用。

operator=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

通过从另一个多人游戏邀请复制来分配此多人游戏邀请。

operator=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

通过将另一个 MultiplayerInvitation 移入此 MultiplayerInvitation 来分配此 MultiplayerInvitation。