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 >
此房间中所有参与者的 vector。
|
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
返回唯一标识此 RealTimeRoom 对象的 ID。
若要在稍后检索此房间，请将此 ID 与 RealTimeRoom::FetchRoom 配合使用。
必须返回 Valid true，此函数才能使用。
Participants
std::vector< MultiplayerParticipant > Participants() const
此房间中所有参与者的 vector。
必须返回 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。
对于 RealTimeRoom 对象上的 getter 函数（例如 Id、CreationTime 等），必须返回 true 才能使用。
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
通过从另一个对象复制来为此 RealTimeRoom 对象赋值。
operator=
RealTimeRoom & operator=( RealTimeRoom && move_from )
通过将另一个对象移动到此对象中来为此 RealTimeRoom 对象赋值。