gpg::RealTimeRoom
#include <real_time_room.h>
包含实时多人游戏房间当前状态的数据结构。
摘要
构造函数和析构函数 |
|
|---|---|
RealTimeRoom()
|
|
RealTimeRoom(std::shared_ptr< const RealTimeRoomImpl > impl)
|
|
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对象。 |
operator=(RealTimeRoom && move_from)
|
通过将另一个对象移动到其中来赋值此
RealTimeRoom对象。 |
公共函数
CreatingParticipant
MultiplayerParticipant CreatingParticipant() const
返回创建此房间的参与者。
Valid必须返回 true，此函数才能使用。
CreationTime
std::chrono::milliseconds CreationTime() const
返回此RealTimeRoom对象创建的时间（自 Unix 纪元以来的毫秒数）。
Valid必须返回 true，此函数才能使用。
Id
const std::string & Id() const
Participants
std::vector< MultiplayerParticipant > Participants() const
此房间中所有参与者的向量。
Valid必须返回 true，此函数才能使用。
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
从指向 RealTimeRoomImpl 对象的 shared_ptr 构造 RealTimeRoom 对象。
供 API 内部使用。
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
返回房间中可用的自动匹配槽位数。
此数字等于创建房间时使用的自动匹配槽位数减去已通过自动匹配添加的参与者数量。Valid必须返回 true，此函数才能使用。
Valid
bool Valid() const
如果此RealTimeRoom对象已填充数据，则返回 true。
必须返回 true，才能使用RealTimeRoom对象上的 getter 函数（Id，CreationTime等）。