Room

房间类

Constructor

new Room()

Members

CustomProperties

获取自定义属性

readonly expectedUserIds :Array.<string>

邀请的好友 ID 列表

readonly master

获取房主

readonly masterId :number

房间主机玩家 ID

readonly maxPlayerCount :number

房间允许的最大玩家数量

readonly name :string

房间名称

readonly opened :boolean

房间是否开启

readonly playerList

获取房间内的玩家列表

readonly visible :boolean

房间是否可见

Methods

getCustomProperties() → {Object}

Returns:
Object
Deprecated:
  • 获取自定义属性

getPlayer(actorId) → {Player}

根据 actorId 获取 Player 对象
Parameters:
Name Type Description
actorId number 玩家在房间中的 Id
Returns:
Player

setCustomProperties(properties, optsopt)

设置房间的自定义属性
Parameters:
Name Type Attributes Description
properties Object 自定义属性
opts Object <optional>
设置选项
Properties
Name Type Attributes Description
expectedValues Object <optional>
期望属性,用于 CAS 检测