JavaScript/TypeScript SDK¶

JavaScript/TypeScript SDK 几乎与所有平台兼容:

浏览器(Google Chrome, Firefox, Safari, Opera, Brave等.)
Node.js
Electron
React Native
Cocos Creator 3.0 (查看说明)

用法¶

将 JavaScript SDK 包括在您的项目中¶

如果您在使用构建工具(webpack, rollup 或类似工具), 这是最佳方式

npm install --save colyseus.js

若您不使用生成工具, 推荐从 GitHub Releases 下载发布的二进制文件.

<script src="colyseus.js"></script>

或者您也可以直接使用 unpkg 加载分布式文件. 记得将其中的 @x.x.x 内容替换为与您服务器兼容的版本.

<script src="https://unpkg.com/colyseus.js@^0.14.0/dist/colyseus.js"></script>

连接至服务器:¶

import * as Colyseus from "colyseus.js"; // not necessary if included via <script> tag.

var client = new Colyseus.Client('ws://localhost:2567');

加入房间:¶

client.joinOrCreate("room_name").then(room => {
    console.log(room.sessionId, "joined", room.name);
}).catch(e => {
    console.log("JOIN ERROR", e);
});

房间事件¶

房间状态已更新:

room.onStateChange((state) => {
  console.log(room.name, "has new state:", state);
});

从服务器广播的消息或直接发给本客户端的消息:

room.onMessage("message_type", (message) => {
  console.log(client.id, "received on", room.name, message);
});

发生服务器错误:

room.onError((code, message) => {
  console.log(client.id, "couldn't join", room.name);
});

服务器离开房间:

room.onLeave((code) => {
  console.log(client.id, "left", room.name);
});