This module provides commonly used client request functionality.

It is available only on Snipe Kit room server.

user.login

Room server client login parameters.

Input:

  • id - User ID. Received in game server user.login response.
  • token - Auth token.

Output:

  • errorCode - String. Operation error code.

Error codes:

  • ok - Operation successful.
  • wrongToken - Incorrect auth token.
  • userDisconnecting - User already logged in to a different room server, disconnect notification send. Repeat login request after a couple of seconds.
  • userNotIngame - User is not online on any game server.

kit/user.ping

Returns the empty response to client ping request.

Output:

  • errorCode - String. Operation error code.

Error codes:

  • ok - Operation successful.

kit/user.logout

If the user is in the room, notifies game server that client state needs to be reset. Then immediately disconnects this client.

Output:

  • No response is sent.

Constructor

Methods