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)
将现有的 MultiplayerInvitation 移到新的 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
)

构造从 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 中所有参与者的矢量。

Valid 必须返回 true 才可用。

类型

MultiplayerInvitationType Type() const

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

有效

bool Valid() const

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

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

变体

uint32_t Variant() const

返回游戏特有的变体标识符，游戏可以使用该标识符来识别游戏模式。

Valid 必须返回 true 才可用。

operator=

MultiplayerInvitation & operator=(
  const MultiplayerInvitation & copy_from
)

通过复制来分配此MultiplayerInvitation。

operator=

MultiplayerInvitation & operator=(
  MultiplayerInvitation && move_from
)

将另一个多人游戏邀请移到该 MultiplayerInvitation 中，以便分配该邀请。