ServerAPI

cloak

Global cloak object.

cloak.configure(config)

Configuration options are given in ServerConfiguration.

Example:

cloak.configure({
  roomLife: 5000,
  messages: {
    foo: function(arg, user) {
      console.log('foo from ' + user.id);
    }
  }
});

cloak.run()

Runs the server. Call cloak.configure first!

Example:

cloak.run();

cloak.userCount()

Returns the number of users on the server. Includes users that are disconnected but have not been pruned per the reconnectWait setting.

cloak.messageAll(name, arg)

The same as doing user.message(name, arg) for every connected user.

cloak.createRoom(name, size)

Create a room. Size is the maximum number of allowed members. If size is omitted, uses the server's defaultRoomSize setting.

cloak.getRoom(id)

Get a room by its ID.

cloak.deleteRoom(room)

Delete a room. All members are kicked out. If the server is configured to autoJoinLobby (as by default) the users are added to the lobby.

cloak.stop()

Stop the game loop, stop accepting new connections, disconnect all users.