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。