gpg::RealTimeRoom

#include <real_time_room.h>

包含实时多人游戏房间的当前状态的数据结构。

摘要

构造函数和析构函数
RealTimeRoom()
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
将 shared_ptr 对象构建为 RealTimeRoomImpl 对象。RealTimeRoom
RealTimeRoom(const RealTimeRoom & copy_from)
创建现有 RealTimeRoom 对象的副本。
RealTimeRoom(RealTimeRoom && move_from)
移动现有 RealTimeRoom 对象。

公共函数
AutomatchWaitEstimate() const
服务器生成的预计时间，表示填满此房间的自动匹配空房所需的时间。
CreatingParticipant() const
返回创建此聊天室的参与者。
CreationTime() const
std::chrono::milliseconds
返回此 RealTimeRoom 对象的创建时间（以自 Unix 纪元起的毫秒数表示）。
Description() const
std::string
返回服务器生成的房间状态摘要。
Id() const
const std::string &
返回用于唯一标识此 RealTimeRoom 对象的 ID。
Participants() const
std::vector< MultiplayerParticipant >
此聊天室中所有参与者的向量。
RemainingAutomatchingSlots() const
uint32_t
返回会议室的可用自动匹配槽位数。
Status() const
返回房间的状态。
Valid() const
bool
如果此 RealTimeRoom 对象已填充数据，则返回 true。
Variant() const
uint32_t
返回游戏专用变体标识符，游戏可以使用该标识符来识别不同的游戏模式。
operator=(const RealTimeRoom & copy_from)
通过从另一个 RealTimeRoom 对象复制来分配此 RealTimeRoom 对象。
operator=(RealTimeRoom && move_from)
通过将另一个 RealTimeRoom 对象移入此 RealTimeRoom 对象来对其进行赋值。

公共函数

AutomatchWaitEstimate

Timeout AutomatchWaitEstimate() const

服务器生成的预计时间，表示填满此房间的自动匹配空房所需的时间。

CreatingParticipant

MultiplayerParticipant CreatingParticipant() const

返回创建此聊天室的参与者。

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

CreationTime

std::chrono::milliseconds CreationTime() const

返回此 RealTimeRoom 对象的创建时间（以自 Unix 纪元起的毫秒数表示）。

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

说明

std::string Description() const

返回服务器生成的房间状态摘要。

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

ID

const std::string & Id() const

返回用于唯一标识此 RealTimeRoom 对象的 ID。

如需稍后检索此房间，请将此 ID 与 RealTimeRoom::FetchRoom 搭配使用。

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

参与者

std::vector< MultiplayerParticipant > Participants() const

此聊天室中所有参与者的矢量。

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

RealTimeRoom

 RealTimeRoom()

RealTimeRoom

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

将 shared_ptr 对象构建为 RealTimeRoomImpl 对象。RealTimeRoom

供 API 内部使用。

RealTimeRoom

 RealTimeRoom(
  const RealTimeRoom & copy_from
)

创建现有 RealTimeRoom 对象的副本。

RealTimeRoom

 RealTimeRoom(
  RealTimeRoom && move_from
)

移动现有 RealTimeRoom 对象。

RemainingAutomatchingSlots

uint32_t RemainingAutomatchingSlots() const

返回会议室的可用自动匹配槽位数。

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

状态

RealTimeRoomStatus Status() const

返回房间的状态。

状态决定了您可以对房间执行哪些操作。有效必须返回 true，此函数才能使用。

有效

bool Valid() const

如果此 RealTimeRoom 对象已填充数据，则返回 true。

必须返回 true，RealTimeRoom 对象（Id、CreationTime 等）上的 getter 函数才能使用。

变体

uint32_t Variant() const

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

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

operator=

RealTimeRoom & operator=(
  const RealTimeRoom & copy_from
)

通过从另一个 RealTimeRoom 对象复制来分配此 RealTimeRoom 对象。

operator=

RealTimeRoom & operator=(
  RealTimeRoom && move_from
)

通过将另一个 RealTimeRoom 对象移入此 RealTimeRoom 对象来对其进行赋值。