# OnlineBattleManager.updateRoomProperties(Object option)
以 Promise 风格调用:支持
# 功能描述
更新房间属性(如房间名称、地图、模式)。房间属性变更会触发所有玩家(包括发送者自己)的 onRoomPropertiesChange 事件。
# 参数
# Object option
| 属性 | 类型 | 默认值 | 必填 | 说明 |
| data | Object | 是 | 更新房间属性数据 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
# data 对象结构
| 属性 | 类型 | 必填 | 说明 |
| name | string | 否 | 房间名称 |
| customProperties | string | 否 | 房间自定义属性(UTF-8字符串,最大2048字节) |
# 注意事项
- 频率限制:与 sendCustomMessage 共享每秒15次
- customProperties 最大2048字节
- 只有房主可以调用此方法
# 示例代码
let tapOnlineBattle = tap.getOnlineBattleManager();
// 回调风格
tapOnlineBattle.updateRoomProperties({
data: {
name: "user_newRoomName",
customProperties: "user_newCustomRoomProperties"
},
success: (res) => {
console.log('更新房间属性成功');
},
fail: ({errMsg, errno}) => {
console.error('更新房间属性失败:', errMsg);
}
});
// Promise风格
tapOnlineBattle.updateRoomProperties({
data: {
name: "user_newRoomName",
customProperties: "user_newCustomRoomProperties"
}
}).then(res => {
console.log('更新房间属性成功');
}).catch(error => {
console.error('更新房间属性失败:', error);
});
