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
RealTimeRoom
RealTimeRoom()
RealTimeRoom
RealTimeRoom( std::shared_ptr< const RealTimeRoomImpl > impl )
构造从 shared_ptr
到 RealTimeRoomImpl
对象的 RealTimeRoom
对象。
供 API 内部使用。
RemainingAutomatchingSlots
uint32_t RemainingAutomatchingSlots() const
返回会议室可用的自动匹配空档数。
此数字等于创建会议室的自动匹配空档数减去已通过自动匹配功能添加的参与者数。Valid 必须返回 true 才可用。
有效
bool Valid() const
如果此 RealTimeRoom
对象中填充了数据,则返回 true。
必须返回 true,RealTimeRoom
对象(Id
、CreationTime
等)上的 getter 函数才可用。
operator=
RealTimeRoom & operator=( const RealTimeRoom & copy_from )
通过从另一个对象复制来分配此 RealTimeRoom
对象。