Clientapi

global cloak object

cloak.configure(config)

Configuration options are given in ClientConfiguration.

Example:

cloak.configure({
  messages: {
    bar: function(arg) {
      console.log('bar from server');
    }
  },
  serverEvents: {
    begin: function() {
      console.log('begin');
    }
  }
});

cloak.run(host)

cloak.run('http://localhost:8090');

cloak.message(name, arg)

Sends a message to the server. The message handler on the server gets called if there is one for this message name.

cloak.connected()

returns true or false

cloak.listRooms(callback)

The callback's argument is the array of all rooms.

cloak.joinRoom(id, callback)

Join room based on the room ID. The callback's argument is an object with a success property that is true or false.

cloak.leaveRoom(callback)

Leave the room you're currently in. You may automatically join the lobby based on server config. You may also be unable to leave if you're in the lobby, again based on server config.