ZEPETO.Multiplay

类型 说明 sandboxplayer /#sandboxplayer 表示已连接到 multiplay room 的玩家客户端。 ibroadcastoptions /#ibroadcastoptions 从 multiplay room 向客户端广播消息时的选项。 sandboxoptions /#sandboxoptions 创建 multiplay room 时的选项。 sandbox /#sandbox 表示 multiplay room。 sandboxplayer interface 表示已连接到 multiplay room 的玩家客户端。 属性 名称 类型 说明 sessionid string 客户端的会话 id userid string 玩家的用户 id 方法 send send(type string | number, message? t) → void 通过指定的频道向客户端发送消息。 参数 类型 说明 type string | number 用于发送消息的频道标识符。 message （可选） t message 要发送的消息内容（可选）。 ibroadcastoptions interface 从 multiplay room 向客户端广播消息时的选项。 属性 名称 类型 说明 except sandboxplayer /#sandboxplayer 指定要从广播中排除的客户端。 sandboxoptions interface 创建 multiplay room 时的选项。 属性 名称 类型 说明 issandbox boolean 指定 room 是否在本地托管，例如在 unity 编辑器中进行 qr 移动端测试的情况。 sandbox class 表示 multiplay room。 属性 名称 类型 说明 locked boolean 指定 multiplay room 是否已锁定。 roomid string multiplay room 的 id，在创建时随机分配以避免重复。 uniqueid string multiplay room 的 id，在创建时显式指定。 maxclients number 可连接到 multiplay room 的最大客户端数量。 state state multiplay room 的状态。状态数据的架构由 multiplay schema 定义。 clients iterableiterator\<sandboxplayer> 已连接到 multiplay room 的客户端的可迭代表示。 allowreconnectiontime number 允许连接不稳定的客户端重新连接的时限（秒）。 private boolean 指定 multiplay room 是否为私密房间。 方法 oncreate oncreate(options sandboxoptions) → void | promise\<void> 该抽象方法的实现会在 multiplay room 创建时执行一次。 该实现可以选择性地声明为 async 。 参数 类型 说明 options sandboxoptions /#sandboxoptions 创建该 multiplay room 时的选项。 返回值： void | promise\<void> — 若为异步，则返回 promise\<void> ；否则返回 void 。 onjoin onjoin(client sandboxplayer) → void | promise\<void> 该抽象方法的实现会在客户端加入 multiplay room 时执行。 该实现可以选择性地声明为 async 。 参数 类型 说明 client sandboxplayer /#sandboxplayer 玩家的客户端对象。 返回值： void | promise\<void> — 若为异步，则返回 promise\<void> ；否则返回 void 。 onleave onleave(client sandboxplayer, consented? boolean) → void | promise\<void> 该抽象方法的实现会在客户端离开 multiplay room 时执行。 该实现可以选择性地声明为 async 。 参数 类型 说明 client sandboxplayer /#sandboxplayer 玩家的客户端对象。 consented （可选） boolean 指定该玩家是否已同意重新连接。 返回值： void | promise\<void> — 若为异步，则返回 promise\<void> ；否则返回 void 。 lock lock() → promise\<void> 锁定 multiplay room。 返回值： promise\<void> — 锁定处理完成时兑现的 promise 。 unlock unlock() → promise\<void> 解锁 multiplay room。 返回值： promise\<void> — 解锁处理完成时兑现的 promise 。 ontick ontick(deltatime number) → void 该方法的实现约每 100 毫秒执行一次。 参数 类型 说明 deltatime number 表示与上一次调用之间的时间差（毫秒）。 onmessage onmessage(messagetype ' ' | string | number, callback (client sandboxplayer, message t) => void) → void 注册用于处理来自客户端消息的回调。 参数 类型 说明 messagetype ' ' | string | number 消息发送所经频道的标识符。 callback (client sandboxplayer, message t) => void 用于处理所接收消息的回调方法。 broadcast broadcast(type string | number, message? any, options? ibroadcastoptions) → void 通过指定的频道向已连接到 multiplay room 的所有客户端发送消息。 参数 类型 说明 type string | number 用于发送消息的频道标识符。 message （可选） any 消息内容（可选）。 options （可选） ibroadcastoptions /#ibroadcastoptions 广播选项。 loadplayer loadplayer(sessionid string) → sandboxplayer | undefined 获取与会话 id 关联的客户端对象。 参数 类型 说明 sessionid string 客户端的会话 id。 返回值： sandboxplayer | undefined — 客户端对象。 setprivate setprivate(isprivate boolean) → promise\<void> 设置 multiplay room 的私密状态。 参数 类型 说明 isprivate boolean 指定 multiplay room 的私密状态。 返回值： promise\<void> — 处理完成时兑现的 promise 。 kick kick(client sandboxplayer, reason? string) → promise\<void> 将客户端踢出 multiplay room。 参数 类型 说明 client sandboxplayer /#sandboxplayer 要踢出的客户端对象。 reason （可选） string 可选择性地说明踢出的原因。 返回值： promise\<void> — 处理完成时兑现的 promise 。