

Overview

Colyseus currently have clients for the platforms:

• HTML5 (colyseus/colyseus.js)
• Defold (colyseus/colyseus-defold)
• Haxe (colyseus/colyseus-hx)
• Cocos2d-X (colyseus/colyseus-cocos2d-x)
• Construct3 (colyseus/colyseus-construct3)
• Unity3D (colyseus/colyseus-unity3d)

Need a client for another platform? Share your interest on the discussion board!

Connecting to the Server

JavaScript

import * as Colyseus from "colyseus.js";
// ...

let client = new Colyseus.Client("ws://localhost:2567");

C#

using Colyseus;
// ...

Client client = new Client("ws://localhost:2567");

lua

local ColyseusClient = require("colyseus.client")
// ...

local client = ColyseusClient.new("ws://localhost:2567");

Haxe

import io.colyseus.Client;
// ...

var client = new Client("ws://localhost:2567");

Methods

join (roomNameOrId: string, options: any)

Joins roomName. roomName can be either a room name or a roomId.

JavaScript

// joining a room by name
let room = client.join("battle");

// joining a room by id
let room = client.join("KRYAKzRo2");

C#

// joining a room by name
Room room = client.Join("battle");

// joining a room by id
Room room = client.Join("KRYAKzRo2");

lua

-- joining a room by name
local room = client:join("battle")

-- joining a room by id
local room = client:join("KRYAKzRo2")

Haxe

// joining a room by name
var room = client.join("battle");

// joining a room by id
var room = client.join("KRYAKzRo2");

Tip

Use getAvailableRooms() to retrieve a list of roomId's available for joining.

rejoin (roomNameOrId: string, sessionId: string)

Reconnects the client into a room he was previously connected with.

Must be used along with allowReconnection() in the server-side.

JavaScript

let room = client.rejoin("battle", "SkNaHTazQ");

C#

Room room = client.ReJoin("battle", "SkNaHTazQ");

lua

local room = client:rejoin("battle", "SkNaHTazQ")

Haxe

var room = client.rejoin("battle", "SkNaHTazQ");

getAvailableRooms (roomName: string)

List all available rooms to connect with the provided roomName. Locked rooms won't be listed.

JavaScript

client.getAvailableRooms("battle", function(rooms, err) {
  if (err) console.error(err);
  rooms.forEach(function(room) {
    console.log(room.roomId);
    console.log(room.clients);
    console.log(room.maxClients);
    console.log(room.metadata);
  });
});

C#

client.GetAvailableRooms("battle", (RoomAvailable[] rooms) => {
  for (int i = 0; i < rooms.Length; i++) {
    Debug.Log(rooms[i].roomId);
    Debug.Log(rooms[i].clients);
    Debug.Log(rooms[i].maxClients);
    Debug.Log(rooms[i].metadata);
  }
);

lua

client:get_available_rooms("battle", function(rooms, err)
  if (err) console.error(err);
  for i, rooms in pairs(rooms) do
    print(rooms[i].roomId)
    print(rooms[i].clients)
    print(rooms[i].maxClients)
    print(rooms[i].metadata)
  end
end);

Haxe

client.getAvailableRooms("battle", function(rooms, ?err) {
  if (err != null) trace(err);
  for (room in rooms) {
    trace(room.roomId);
    trace(room.clients);
    trace(room.maxClients);
    trace(room.metadata);
  }
});

close ()

Close connection with the server.

JavaScript

client.close();

C#

client.Close();

lua

client:close()

Haxe

client.close();

Events

onOpen

This event is triggered when the connection is accepted by the server.

JavaScript

client.onOpen.add(function() {
  console.log("connection is now open");
});

C#

client.OnOpen += (object sender, EventArgs e) => {
  Debug.Log ("connection is now open");
}

lua

client:on('open', function()
  print("connection is now open")
end)

Haxe

client.onOpen = function() {
  trace("connection is now open");
};

onClose

This event is triggered when the connection is closed.

JavaScript

client.onClose.add(function() {
  console.log("connection has been closed");
});

C#

client.OnClose += (object sender, EventArgs e) => {
  Debug.Log ("connection has been closed");
}

lua

client:on('close', function()
  print("connection has been closed")
end)

Haxe

client.onClose = function() {
  trace("connection has been closed");
};

onError

This event is triggered when some error occurs in the server.

JavaScript

client.onError.add(function(err) {
  console.log("something wrong happened", err);
});

C#

client.OnError += (object sender, EventArgs e) => {
  Debug.Log ("something wrong happened");
}

lua

client:on("error", function()
  print("something wrong happened")
end)

Haxe

client.onError = function() {
  trace("something wrong happened");
};

Properties

id: string

Unique identifier for the client.

Note

The same client id can connect into the same room handler when joining from multiple browser tabs.