/** * Creates a new SmartFox instance. * *

The SmartFox class is responsible for connecting the client to a SmartFoxServer instance and for dispatching all asynchronous events. * Developers always interact with SmartFoxServer through this class.
* For detailed informations please check our website: http://www.smartfoxserver.com.

* *

The SmartFox instance can be configured through a configuration object with the following properties (all optional):

* * * * * * * * *
PropertyTypeDescription
hoststringThe IP address or host name of the SmartFoxServer 2X instance to connect to.
portnumberThe WebSocket port of the SmartFoxServer 2X instance to connect to.
useSSLbooleanUse an encrypted SSL connection (WebSocket Secure).
zonestringThe Zone of the SmartFoxServer 2X instance to join during the login process.
debugbooleanIndicates whether the client-server messages console debug should be enabled or not.
* *

NOTE: in the examples provided throughout the documentation, sfs always indicates a SmartFox instance.

* @example * This example instantiates the SmartFox class passing a configuration object. * function init() * { * // Create configuration object * var config = {}; * config.host = "127.0.0.1"; * config.port = 8080; * config.useSSL = false; * config.zone = "BasicExamples"; * config.debug = false; * * // Create SmartFox client instance * sfs = new SFS2X.SmartFox(config); * } * @param [configObj = null] - An object containing the client configuration properties. */ export class SmartFox extends EventDispatcher { constructor(configObj?: any); /** * Indicates whether the client-server messages console debug is enabled or not. *

If set to true, detailed debugging informations for all the incoming and outgoing messages are provided in the browser's debug console (if available). * Debugging can be enabled when instantiating the SmartFox class too by means of the configuration object.

*/ debug: boolean; /** * Returns the current version of the SmartFoxServer 2X JavaScript API. */ readonly version: string; /** * Returns the client configuration object passed during the SmartFox instance creation. */ readonly config: any; /** * Returns a reference to the internal Logger instance used by SmartFoxServer 2X. */ readonly logger: Logger; /** * Returns the unique session token of the client. *

The session token is a string sent by the server to the client after the initial handshake.
* It is required as mean of identification when uploading files to the server (see specific documentation).

*/ readonly sessionToken: string; /** * Returns a reference to the Room Manager. *

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property * gives access to the Rooms list and Groups, allowing interaction with SFSRoom objects.

*/ readonly roomManager: SFSRoomManager; /** * Returns a reference to the User Manager. *

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property * gives access to the users list, allowing interaction with SFSUser objects.

*/ readonly userManager: SFSUserManager; /** * Returns a reference to the Buddy Manager. *

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property * gives access to the buddies list, allowing interaction with Buddy and BuddyVariable objects and access to user properties in the Buddy List system.

*/ readonly buddyManager: SFSBuddyManager; /** * Returns the SFSUser object representing the client itself when connected to a SmartFoxServer 2X instance. * *

This object is generated upon successful login only, so it is null if login was not performed yet.

* *

NOTE: setting the mySelf property manually can disrupt the API functioning.

*/ readonly mySelf: SFSUser; /** * Returns the object representing the last Room joined by the client, if any. * *

This property is null if no Room was joined.

*/ readonly lastJoinedRoom: SFSRoom; /** * Indicates whether the client is connected to the server or not. * @example * This example checks the connection status. * console.log("Am I connected? " + sfs.isConnected); */ readonly isConnected: boolean; /** * Returns the maximum size of messages allowed by the server. *

Any request exceeding this size will not be sent. The value is determined by the server configuration.

*/ readonly maxMessageSize: number; /** * [CLUSTER] The identifier of the cluster node which the current SmartFox instance is connected to. * *

If the SmartFox instance is not connected to a cluster node, this property is null.

*/ readonly nodeId: string; /** * Allows to specify custom client details that will be used to gather statistics about the client platform via the AdminTool's Analytics Module. * *

By default no details are sent and the client type is the generic "JavaScript".

* *

NOTE: this method must be called before the connection is started. The length of the two strings combined must be less than 512 characters.

* @param platformId - An identification string for the client, like the browser name for example. * @param version - An additional string to describe the client version, like the browser version for example. */ setClientDetails(platformId: string, version: string): void; /** * Establishes a connection between the client and a SmartFoxServer 2X instance. * *

If one or more arguments are missing, the client will use the corresponding settings passed during the SmartFox class instantiation.

* @example * This example connects to a local SmartFoxServer 2X instance. * function someMethod() * { * sfs = new SFS2X.SmartFox(); * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * * // Connect * sfs.connect(127.0.0.1, 8080); * } * * function onConnection(evtParams) * { * if (evtParams.success) * console.log("Connection established"); * else * console.log("Connection failed"); * } * @param [host = null] - The address of the server to connect to. * @param [port = -1] - The TCP port to connect to. * @param [useSSL = null] - Use an encrypted SSL connection. */ connect(host?: string, port?: number, useSSL?: boolean): void; /** * Closes the connection between the client and the SmartFoxServer 2X instance. */ disconnect(): void; /** * Simulates an abrupt disconnection from the server. * *

This method should be used for testing and simulations only, otherwise use the method.

*/ killConnection(): void; /** * Enables the automatic realtime monitoring of the lag between the client and the server (round robin). * *

When turned on, the pingPong event type is dispatched continuously, providing the average of the last ten measured lag values. * The lag monitoring is automatically halted when the user logs out of a Zone or gets disconnected.

* *

NOTE: the lag monitoring can be enabled after the login has been completed successfully only.

* @param enabled - The lag monitoring status: true to start the monitoring, false to stop it. * @param [interval = 4] - The amount of seconds to wait between each query (recommended 3-4s). * @param [queueSize = 10] - The amount of values stored temporarily and used to calculate the average lag. */ enableLagMonitor(enabled: boolean, interval?: number, queueSize?: number): void; /** * Sends a request to the server. * @example * This example shows how to send a login request. * sfs.send(new SFS2X.LoginRequest("KermitTheFrog", "kermitPwd", null, "TheMuppetZone")); * @example * This example sends a "join room" request. * sfs.send(new SFS2X.JoinRoomRequest("Lobby")); * @example * This example creates an object containing some parameters and sends it to the server-side Extension. * var params = new SFS2X.SFSObject(); * params.putInt("x", 10); * params.putInt("y", 37); * * sfs.send(new SFS2X.ExtensionRequest("setPosition", params)); * @param request - A request object. */ send(request: BaseRequest): void; /** * Retrieves a SFSRoom object from its id. * *

NOTE: the same object is returned by the SFSRoomManager.getRoomById() method, accessible through the roomManager property; * this was replicated on the SmartFox class for handy access due to its usually frequent usage.

* @example * This example retrieves a SFSRoom object and traces its name. * var roomId = 3; * var room = sfs.getRoomById(roomId); * console.log("The name of Room " + roomId + " is " + room.name); * @param id - The id of the Room. * @returns The object representing the requested Room; undefined if no SFSRoom object with the passed id exists in the Rooms list. */ getRoomById(id: number): SFSRoom; /** * Retrieves a SFSRoom object from its name. * *

NOTE: the same object is returned by the SFSRoomManager.getRoomByName() method, accessible through the roomManager property; * this was replicated on the SmartFox class for handy access due to its usually frequent usage.

* @example * This example retrieves a SFSRoom object and traces its id. * var roomName = "The Lobby"; * var room = sfs.getRoomByName(roomName); * console.log("The ID of Room '" + roomName + "' is " + room.id); * @param name - The name of the Room. * @returns The object representing the requested Room; undefined if no SFSRoom object with the passed name exists in the Rooms list. */ getRoomByName(name: string): SFSRoom; /** * Returns the list of SFSRoom objects representing the Rooms currently "watched" by the client. * *

The list contains all the Rooms that are currently joined and all the Rooms belonging to the Room Groups that have been subscribed by the client.

* *

NOTE 1: at login time, the client automatically subscribes all the Room Groups specified in the Zone's Default Room Groups setting.

* *

NOTE 2: the same list is returned by the SFSRoomManager.getRoomList() method, accessible through the roomManager property; * this was replicated on the SmartFox class for handy access due to its usually frequent usage.

* @returns The list of SFSRoom objects representing the Rooms available on the client. */ getRoomList(): SFSRoom[]; /** * Retrieves the list of Rooms which are part of the specified Room Group. * *

NOTE: the same list is returned by the SFSRoomManager.getRoomListFromGroup() method, accessible through the roomManager property; * this was replicated on the SmartFox class for handy access due to its usually frequent usage.

* @param groupId - The name of the Group. * @returns The list of SFSRoom objects belonging to the passed Group. */ getRoomListFromGroup(groupId: string): SFSRoom[]; /** * Returns a list of SFSRoom objects representing the Rooms currently joined by the client. * *

NOTE: the same list is returned by the SFSRoomManager.getJoinedRooms() method, accessible through the roomManager property; * this was replicated on the SmartFox class for handy access due to its usually frequent usage.

* @returns The list of SFSRoom objects representing the Rooms joined by the client. */ getJoinedRooms(): SFSRoom[]; /** * Registers an event listener function that will receive notification of an event. * *

If you no longer need an event listener, remove it by calling the removeEventListener() method, or memory issues could arise. * In fact event listeners are not automatically removed from memory.

* @example * This example shows how to add a number of common event listeners to the SmartFox instance, usually during initialization: * function init() * { * sfs = new SFS2X.SmartFox(); * * // Add LoggerEvent listeners * sfs.logger.addEventListener(SFS2X.LoggerEvent.DEBUG, onDebugMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.INFO, onInfoMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.WARNING, onWarningMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.ERROR, onErrorMessage, this); * * // Add SFSEvent listeners * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION_LOST, onConnectionLost, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN_ERROR, onLoginError, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN, onLogin, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGOUT, onLogout, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoin, this); * } * @param evtType - The type of event to listen to, among those available in the SFSEvent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function that processes the event. This function should accept an object as its only parameter, which in turn contains the event parameters. * @param scope - The object that acts as a context for the event listener: it is the object that acts as a "parent scope" for the callback function, thus providing context (i.e. access to variables and other mehtods) to the function itself. */ addEventListener(evtType: string, callback: (...params: any[]) => any, scope: any): void; /** * Removes an event listener. * @param evtType - The type of event to remove, among those available in the SFSevent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function to be removed. */ removeEventListener(evtType: string, callback: (...params: any[]) => any): void; } /** * Developers never istantiate the EventDispatcher class: this is done internally by the SmartFoxServer 2X API. */ export class EventDispatcher { /** * Registers an event listener function that will receive notification of an event. * *

If you no longer need an event listener, remove it by calling the removeEventListener() method, or memory issues could arise. * In fact event listeners are not automatically removed from memory.

* @example * This example shows how to add a number of common event listeners to the SmartFox instance, usually during initialization: * function init() * { * sfs = new SFS2X.SmartFox(); * * // Add LoggerEvent listeners * sfs.logger.addEventListener(SFS2X.LoggerEvent.DEBUG, onDebugMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.INFO, onInfoMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.WARNING, onWarningMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.ERROR, onErrorMessage, this); * * // Add SFSEvent listeners * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION_LOST, onConnectionLost, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN_ERROR, onLoginError, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN, onLogin, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGOUT, onLogout, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoin, this); * } * @param evtType - The type of event to listen to, among those available in the SFSEvent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function that processes the event. This function should accept an object as its only parameter, which in turn contains the event parameters. * @param scope - The object that acts as a context for the event listener: it is the object that acts as a "parent scope" for the callback function, thus providing context (i.e. access to variables and other mehtods) to the function itself. */ addEventListener(evtType: string, callback: (...params: any[]) => any, scope: any): void; /** * Removes an event listener. * @param evtType - The type of event to remove, among those available in the SFSevent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function to be removed. */ removeEventListener(evtType: string, callback: (...params: any[]) => any): void; } /** * Developers never istantiate the SFSEvent class: only use its static properties. * *

The constants contained in this class are used to register the event listeners; when an event is dispatched, an object containing event-specific parameters is passed to the listener. * See the documentation below for a description of the parameters available for each event.

* @example * This example shows the generic approach to be implemented to listen to events; please refer to the specific event types for the parameters object content. * var sfs = null; * * function init() * { * // Create SmartFox client instance * sfs = new SFS2X.SmartFox(); * * // Add event listener for connection * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * * // Connect to the server * sfs.connect("127.0.0.1", 8080); * } * * // Handle connection event * function onConnection(evtParams) * { * if (evtParams.success) * console.log("Connected to SmartFoxServer 2X!"); * else * console.log("Connection failed. Is the server running at all?"); * } */ export class SFSEvent { constructor(); /** * The connection event type, dispatched when a connection between the client and a SmartFoxServer 2X instance is attempted. * *

This event is fired in response to a call to the SmartFox.connect() method.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
successbooleanThe connection result: true if a connection was established, false otherwise.
* @example * This example starts a connection. * function someMethod() * { * sfs = new SFS2X.SmartFox(); * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * * sfs.connect(127.0.0.1, 8080); * } * * function onConnection(evtParams) * { * if (evtParams.success) * console.log("Connection established"); * else * console.log("Connection failed"); * } */ static readonly CONNECTION: string; /** * The connectionLost event type, dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted. * *

This event is fired in response to a call to the SmartFox.disconnect() method.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
reasonstringThe reason of the disconnection, among those available in the ClientDisconnectionReason class.
* @example * This example handles a disconnection event: * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION_LOST, onConnectionLost, this); * } * * function onConnectionLost(evtParams) * { * var reason = evtParams.reason; * * if (reason != SFS2X.ClientDisconnectionReason.MANUAL) * { * if (reason == SFS2X.ClientDisconnectionReason.IDLE) * console.log("A disconnection occurred due to inactivity"); * else if (reason == SFS2X.ClientDisconnectionReason.KICK) * console.log("You have been kicked by the moderator"); * else if (reason == SFS2X.ClientDisconnectionReason.BAN) * console.log("You have been banned by the moderator"); * else * console.log("A disconnection occurred due to unknown reason; please check the server log"); * } * else * { * // Manual disconnection is usually ignored * } * } */ static readonly CONNECTION_LOST: string; /** * The login event type, dispatched when the current user performs a successful login in a server Zone. * *

This event is fired in response to the LoginRequest request.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
user{@link SFSUser}An object representing the user who performed the login.
data{@link SFSObject}A SFSObject containing custom parameters returned by a custom login system, if any.
* @example * This example performs a login in the "BasicExamples" Zone: * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.LOGIN, onLogin, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN_ERROR, onLoginError, this); * * // Login * sfs.send(new SFS2X.LoginRequest("FozzieTheBear", "", "BasicExamples")); * } * * function onLogin(evtParams) * { * console.log("Login successful!"); * } * * function onLoginError(evtParams * { * console.log("Login failure: " + evtParams.errorMessage); * } */ static readonly LOGIN: string; /** * The loginError event type, dispatched if an error occurs while the user login is being performed. * *

This event is fired in response to the LoginRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the LOGIN constant description.

*/ static readonly LOGIN_ERROR: string; /** * The logout event type, dispatched when the current user performs logs out of the server Zone. * *

This event is fired in response to the LogoutRequest request.

* * * *
No parameters are available for this event object.
* @example * This example performs a logout from the current Zone. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.LOGOUT, onLogout, this); * * // Logout * sfs.send(new SFS2X.Requests.System.LogoutRequest()); * } * * function onLogout(evtParams) * { * console.log("Logout executed!"); * } */ static readonly LOGOUT: string; /** * The roomAdd event type, dispatched when a new Room is created inside the Zone under any of the Room Groups that the client subscribed. * *

This event is fired in response to the CreateRoomRequest and CreateSFSGameRequest requests in case the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room that was created.
* @example * This example creates a new chat Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_ADD, onRoomCreated, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CREATION_ERROR, onRoomCreationError, this); * * // Define the settings of a new chat Room * var settings = new SFS2X.RoomSettings("My Chat Room"); * settings.maxUsers = 40; * settings.groupId = "chats"; * * // Create the Room * sfs.send(new SFS2X.CreateRoomRequest(settings)); * } * * function onRoomCreated(evtParams) * { * console.log("Room created: " + evtParams.room); * } * * function onRoomCreationError(evtParams) * { * console.log("Room creation failure: " + evtParams.errorMessage); * } */ static readonly ROOM_ADD: string; /** * The roomCreationError event type, dispatched if an error occurs while creating a new Room. * *

This event is fired in response to the CreateRoomRequest and CreateSFSGameRequest requests in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_ADD constant description.

*/ static readonly ROOM_CREATION_ERROR: string; /** * The roomRemove event type, dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the Zone. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room that was removed.
* @example * This example shows how to handle this event type. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_REMOVE, onRoomRemoved, this); * } * * function onRoomRemoved(evtParams) * { * console.log("The following Room was removed: " + evtParams.room); * } */ static readonly ROOM_REMOVE: string; /** * The roomJoin event type, dispatched when a Room is joined by the current user. * *

This event is fired in response to the JoinRoomRequest and QuickJoinGameRequest requests in case the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room that was joined.
* @example * This example makes the user join an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoined, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this); * * // Join a Room called "Lobby" * sfs.send(new SFS2X.JoinRoomRequest("Lobby")); * } * * function onRoomJoined(evtParams) * { * console.log("Room joined successfully: " + evtParams.room); * } * * function onRoomJoinError(evtParams) * { * console.log("Room joining failed: " + evtParams.errorMessage); * } */ static readonly ROOM_JOIN: string; /** * The roomJoinError event type, dispatched when an error occurs while the current user is trying to join a Room. * *

This event is fired in response to the JoinRoomRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_JOIN constant description.

*/ static readonly ROOM_JOIN_ERROR: string; /** * The userEnterRoom event type, dispatched when one of the Rooms joined by the current user is entered by another user. * *

This event is caused by a JoinRoomRequest request; it might be fired or not depending on the Room configuration defined upon its creation (see the RoomSettings.events setting).

* *

NOTE: if the Room is of type MMORoom, this event is never fired and it is substituted by the proximityListUpdate event.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
user{@link SFSUser}An object representing the user who joined the Room.
room{@link SFSRoom}An object representing the Room that was joined by a user.
* @example * This example shows how to handle this event type. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_ENTER_ROOM, onUserEnterRoom, this); * } * * function onUserEnterRoom(evtParams) * { * var room = evtParams.room; * var user = evtParams.user; * * console.log("User " + user.name + " just joined Room " + room.name); * } */ static readonly USER_ENTER_ROOM: string; /** * The userExitRoom event type, dispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself. * *

This event is caused by a LeaveRoomRequest request; it might be fired or not depending on the Room configuration defined upon its creation (see the RoomSettings.events setting).

* *

NOTE: if the Room is of type MMORoom, this event is fired when the current user leaves the Room only. * For the other users leaving the Room it is substituted by the proximityListUpdate event.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
user{@link SFSUser}An object representing the user who left the Room.
room{@link SFSRoom}An object representing the Room that was left by a user.
* @example * This example shows how to handle this event type. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_EXIT_ROOM, onUserExitRoom, this); * } * * function onUserExitRoom(evtParams) * { * var room = evtParams.room; * var user = evtParams.user; * * console.log("User " + user.name + " just left Room " + room.name); * } */ static readonly USER_EXIT_ROOM: string; /** * The userCountChange event type, dispatched when the number of users/players or spectators inside a Room changes. * *

This event is caused by a JoinRoomRequest request or a LeaveRoomRequest request. * The Room must belong to one of the Groups subscribed by the current client; also this event might be fired or not depending on * the Room configuration defined upon its creation (see the RoomSettings.events setting).

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room in which the users count changed.
uCountnumberThe new users count (players in case of Game Room).
sCountnumberThe new spectators count (Game Room only).
* @example * This example shows how to handle this event type. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_COUNT_CHANGE, onUserCountChange, this); * } * * function onUserCountChange(evtParams) * { * var room = evtParams.room; * var uCount = evtParams.uCount; * var sCount = evtParams.sCount; * * console.log("Room: " + room.name + " now contains " + uCount + " users and " + sCount + " spectators"); * } */ static readonly USER_COUNT_CHANGE: string; /** * The proximityListUpdate event type, dispatched when one more users or one or more MMOItem objects enter/leave the current user's Area of Interest in a MMORoom. * *

This event is fired after an MMORoom is joined and the SetUserPositionRequest request is sent at least one time.

* *

NOTE: this event substitutes the default userEnterRoom and userExitRoom events available in regular Rooms.

* * * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
addedUsersArray of {@link SFSUser}A list of SFSUser objects representing the users who entered the current user's Area of Interest.
removedUsersArray of {@link SFSUser}A list of SFSUser objects representing the users who left the current user's Area of Interest.
addedItemsArray of {@link MMOItem}A list of MMOItem objects which entered the current user's Area of Interest.
removedItemsArray of {@link MMOItem}A list of MMOItem objects which left the current user's Area of Interest.
* @example * This example shows how to handle the proximity user list provided by the event in order to add new avatars on the screen and remove those who left the current user's proximity range. * function onProximityListUpdate(evtParams) * { * var added = evtParams.addedUsers; * var removed = evtParams.removedUsers; * * // Add users that entered the proximity list * for (var i = 0; i < added.length; i++) * { * var user = added[i]; * * // Obtain the coordinates at which the user "appeared" in our range * var entryPoint = user.aoiEntryPoint; * * // Add new avatar on screen * var avatarSprite = new AvatarSprite(); * avatarSprite.x = entryPoint.px; * avatarSprite.y = entryPoint.py; * ... * } * * // Remove users that left the proximity list * for (var j = 0; j < removed.length; j++) * { * var user = removed[j]; * * // Remove the avatar from screen * ... * } * } */ static readonly PROXIMITY_LIST_UPDATE: string; /** * The playerToSpectator event type, dispatched when a player is turned to a spectator inside a Game Room. * *

This event is fired in response to the PlayerToSpectatorRequest> request if the operation is executed successfully.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room in which the player is turned to spectator.
user{@link SFSUser}An object representing the player who was turned to spectator.
* @example * This example turns the current user from player to spectator in the last joined Game Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PLAYER_TO_SPECTATOR, onPlayerToSpectatorSwitch, this); * sfs.addEventListener(SFS2X.SFSEvent.PLAYER_TO_SPECTATOR_ERROR, onPlayerToSpectatorSwitchError, this); * * // Switch player to spectator * sfs.send(new SFS2X.PlayerToSpectatorRequest()); * } * * function onPlayerToSpectatorSwitch(evtParams) * { * console.log("Player " + evtParams.user + " is now a spectator"); * } * * function onPlayerToSpectatorSwitchError(evtParams) * { * console.log("Unable to become a spectator due to the following error: " + evtParams.errorMessage); * } */ static readonly PLAYER_TO_SPECTATOR: string; /** * The playerToSpectatorError event type, dispatched when an error occurs while the current user is being turned from player to spectator in a Game Room. * *

This event is fired in response to the PlayerToSpectatorRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the PLAYER_TO_SPECTATOR constant description.

*/ static readonly PLAYER_TO_SPECTATOR_ERROR: string; /** * The spectatorToPlayer event type, dispatched when a spectator is turned to a player inside a Game Room. * *

This event is fired in response to the SpectatorToPlayerRequest> request if the operation is executed successfully.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room in which the spectator is turned to player.
user{@link SFSUser}An object representing the spectator who was turned to player.
playerIdnumberThe player id of the user.
* @example * This example turns the current user from spectator to player in the last joined Game Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.SPECTATOR_TO_PLAYER, onSpectatorToPlayerSwitch, this); * sfs.addEventListener(SFS2X.SFSEvent.SPECTATOR_TO_PLAYER_ERROR, onSpectatorToPlayerSwitchError, this); * * // Switch spectator to player * sfs.send(new SFS2X.SpectatorToPlayerRequest()); * } * * function onSpectatorToPlayerSwitch(evtParams) * { * console.log("Spectator " + evtParams.user + " is now a player"); * } * * function onSpectatorToPlayerSwitchError(evtParams) * { * console.log("Unable to become a player due to the following error: " + evtParams.errorMessage); * } */ static readonly SPECTATOR_TO_PLAYER: string; /** * The spectatorToPlayerError event type, dispatched when an error occurs while the current user is being turned from spectator to player in a Game Room. * *

This event is fired in response to the SpectatorToPlayerRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the SPECTATOR_TO_PLAYER constant description.

*/ static readonly SPECTATOR_TO_PLAYER_ERROR: string; /** * The roomNameChange event type, dispatched when the name of a Room is changed. * *

This event is fired in response to the ChangeRoomNameRequest request if the operation is executed successfully.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room which was renamed.
oldNamestringThe previous name of the Room.
* @example * This example renames an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_NAME_CHANGE, onRoomNameChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_NAME_CHANGE_ERROR, onRoomNameChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * sfs.send(new SFS2X.ChangeRoomNameRequest(theRoom, "Gonzo The Great's Room")); * } * * function onRoomNameChanged(evtParams) * { * console.log("Room " + evtParams.oldName + " was successfully renamed to " + evtParams.room.name); * } * * function onRoomNameChangeError(evtParams) * { * console.log("Room name change failed: " + evtParams.errorMessage); * } */ static readonly ROOM_NAME_CHANGE: string; /** * The roomNameChangeError event type, dispatched when an error occurs while attempting to change the name of a Room. * *

This event is fired in response to the ChangeRoomNameRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_NAME_CHANGE constant description.

*/ static readonly ROOM_NAME_CHANGE_ERROR: string; /** * The roomPasswordStateChange event type, dispatched when the password of a Room is set, changed or removed. * *

This event is fired in response to the ChangeRoomPasswordStateRequest> request if the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room whose password was changed.
* @example * This example changes the password of an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE, onRoomPasswordStateChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR, onRoomPasswordStateChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * sfs.send(new SFS2X.ChangeRoomPasswordStateRequest(theRoom, "mammamia")); * } * * function onRoomPasswordStateChanged(evtParams) * { * console.log("The password of Room " + evtParams.room.name + " was changed successfully"); * } * * function onRoomPasswordStateChangeError(evtParams) * { * console.log("Room password change failed: " + evtParams.errorMessage); * } */ static readonly ROOM_PASSWORD_STATE_CHANGE: string; /** * The roomPasswordStateChangeError event type, dispatched when an error occurs while attempting to set, change or remove the password of a Room. * *

This event is fired in response to the ChangeRoomPasswordStateRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_PASSWORD_STATE_CHANGE constant description.

*/ static readonly ROOM_PASSWORD_STATE_CHANGE_ERROR: string; /** * The roomCapacityChange event type, dispatched when the capacity of a Room is changed. * *

This event is fired in response to the ChangeRoomCapacityRequest> request if the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room whose capacity was changed.
* @example * This example changes the capacity of an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CAPACITY_CHANGE, onRoomCapacityChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CAPACITY_CHANGE_ERROR, onRoomCapacityChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * * // Resize the Room so that it allows a maximum of 100 users and zero spectators * sfs.send(new SFS2X.ChangeRoomCapacityRequest(theRoom, 100, 0)); * } * * function onRoomCapacityChanged(evtParams) * { * console.log("The capacity of Room " + evtParams.room.name + " was changed successfully"); * } * * function onRoomCapacityChangeError(evtParams) * { * console.log("Room capacity change failed: " + evtParams.errorMessage); * } */ static readonly ROOM_CAPACITY_CHANGE: string; /** * The roomCapacityChangeError event type, dispatched when an error occurs while attempting to change the capacity of a Room. * *

This event is fired in response to the ChangeRoomCapacityRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_CAPACITY_CHANGE constant description.

*/ static readonly ROOM_CAPACITY_CHANGE_ERROR: string; /** * The publicMessage event type, dispatched when a public message is received by the current user. * *

This event is caused by a PublicMessageRequest request sent by any user in the target Room, including the current user himself.

* * * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room at which the message is targeted.
sender{@link SFSUser}An object representing the user who sent the message.
messagestringThe message sent by the user.
data{@link SFSObject}A SFSObject containing custom parameters which might accompany the message.
* @example * This example sends a public message and handles the respective event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PUBLIC_MESSAGE, onPublicMessage, this); * * // Send a public message * sfs.send(new SFS2X.PublicMessageRequest("Hello everyone!")); * } * * function onPublicMessage(evtParams) * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var sender = evtParams.sender; * * if (sender == sfs.mySelf) * console.log("I said: " + evtParams.message); * else * console.log("User " + sender.name + " said: " + evtParams.message); * } */ static readonly PUBLIC_MESSAGE: string; /** * The privateMessage event type, dispatched when a private message is received by the current user. * *

This event is caused by a PrivateMessageRequest request sent by any user in the Zone.

* *

NOTE: the same event is fired by the sender's client too, so that the user is aware that the message was delivered successfully to the recipient, * and it can be displayed in the private chat area keeping the correct message ordering. In this case there is no default way to know who the message was originally sent to. * As this information can be useful in scenarios where the sender is chatting privately with more than one user at the same time in separate windows or tabs * (and we need to write his own message in the proper one), the data parameter can be used to store, for example, the id of the recipient user.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
sender{@link SFSUser}An object representing the user who sent the message.
messagestringThe message sent by the user.
data{@link SFSObject}A SFSObject containing custom parameters which might accompany the message.
* @example * This example sends a private message and handles the respective event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PRIVATE_MESSAGE, onPrivateMessage, this); * * // Send a private message to Jack * var user = sfs.usermanager.getUserByName("Jack"); * sfs.send(new SFS2X.PrivateMessageRequest("Hello my friend!", user.id)); * } * * function onPrivateMessage(evtparams) * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var sender = evtParams.sender; * * if (sender != sfs.mySelf) * console.log("User " + sender.name + " sent me this PM: " + evtParams.message); * } */ static readonly PRIVATE_MESSAGE: string; /** * The objectMessage event type, dispatched when an object containing custom data is received by the current user. * *

This event is caused by an ObjectMessageRequest request sent by any user in the target Room.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
sender{@link SFSUser}An object representing the user who sent the message.
message{@link SFSObject}The content of the message: a SFSObject containing the custom parameters sent by the sender.
* @example * This example sends the player's avatar movement coordinates and handles the respective event (note: the myAvatar instance is supposed to be the user sprite on the stage, while the getUserAvatar method retrieves the sprite of other users' characters). * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.OBJECT_MESSAGE, onObjectMessage, this); * * // Send my movement to all players * var dataObj = new SFSObject(); * dataObj.putInt("x", myAvatar.x); * dataObj.putInt("y", myAvatar.y); * * sfs.send(new SFS2X.ObjectMessageRequest(dataObj)); * } * * private function onObjectMessage(evtParams) * { * var dataObj = evtParams.message; // This is a SFSObject! * * var sender = evtParams.sender; * var avatar = getUserAvatar(sender.id); * * avatar.x = dataObj.get("x"); * avatar.y = dataObj.get.("y"); * } */ static readonly OBJECT_MESSAGE: string; /** * The moderatorMessage event type, dispatched when the current user receives a message from a moderator user. * *

This event can be caused by either the ModeratorMessageRequest, KickUserRequest or * BanUserRequest requests sent by a user with at least moderation privileges. * Also, this event can be caused by a kick/ban action executed through the SmartFoxServer 2X Administration Tool.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
sender{@link SFSUser}An object representing the moderator user who sent the message.
messagestringThe message sent by the moderator.
data{@link SFSObject}A SFSObject containing custom parameters which might accompany the message.
* @example * This example sends a moderator message to all the users in the last joned Room; it also shows how to handle the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.MODERATOR_MESSAGE, onModeratorMessage, this); * * // Set the message recipients: all users in the current Room * var recipMode = new SFS2X.MessageRecipientMode(SFS2X.MessageRecipientMode.TO_ROOM, sfs.lastJoinedRoom); * * // Send the moderator message * sfs.send(new SFS2X.ModeratorMessageRequest("Hello everybody, I'm the Moderator!", recipMode)); * } * * function onModeratorMessage(evtParams) * { * console.log("The moderator sent the following message: " + evtParams.message); * } */ static readonly MODERATOR_MESSAGE: string; /** * The adminMessage event type, dispatched when the current user receives a message from an administrator user. * *

This event is caused by the AdminMessageRequest request sent by a user with administration privileges.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
sender{@link SFSUser}An object representing the administrator user who sent the message.
messagestringThe message sent by the administrator.
data{@link SFSObject}A SFSObject containing custom parameters which might accompany the message.
* @example * This example sends an administration message to all the users in the Zone; it also shows how to handle the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ADMIN_MESSAGE, onAdminMessage, this); * * // Set the message recipients: all users in the Zone * var recipMode = new SFS2X.MessageRecipientMode(SFS2X.MessageRecipientMode.TO_ZONE, null); * * // Send the administrator message * sfs.send(new SFS2X.AdminMessageRequest("Hello to everybody from the Administrator!", recipMode)); * } * * function onAdminMessage(evtParams) * { * console.log("The administrator sent the following message: " + evtParams.message); * } */ static readonly ADMIN_MESSAGE: string; /** * The extensionResponse event type, dispatched when data coming from a server-side Extension is received by the current user. * *

Data is usually sent by the server to one or more clients in response to an ExtensionRequest request, but not necessarily.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
cmdstringThe name of the command which identifies an action that should be executed by the client. * If this event is fired in response to a request sent by the client, it is a common practice * to use the same command name passed to the request also in the response.
params{@link SFSObject}A SFSObject containing custom data sent by the Extension.
room{@link SFSRoom}An object representing the Room which the Extension is attached to (for Room Extensions only).
* @example * This example sends a command to the Zone Extension; it also handles responses coming from the Extension by implementing the EXTENSION_RESPONSE listener (the same command name is used in both the request and the response). * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.EXTENSION_RESPONSE, onExtensionResponse, this); * * // Send two integers to the Zone extension and get their sum in return * var params = new SFSObject(); * params.putInt("n1", 26); * params.putInt("n2", 16); * * sfs.send(new SFS2X.ExtensionRequest("add", params)); * } * * function onExtensionResponse(evtParams) * { * if (evtParams.cmd == "add") * { * var responseParams = evtParams.params; * * // We expect a number called "sum" * console.log("The sum is: " + responseParams.get("sum")); * } * } */ static readonly EXTENSION_RESPONSE: string; /** * The roomVariablesUpdate event type, dispatched when a Room Variable is updated. * *

This event is caused by the SetRoomVariablesRequest request. The request could have been sent by a user in the same Room of the current user or, * in case of a global Room Variable, by a user in a Room belonging to one of the Groups subscribed by the current client.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link SFSRoom}An object representing the Room where the Room Variable update occurred.
changedVarsArray of stringThe list of names of the Room Variables that were changed (or created for the first time).
* @example * This example sets a number of Room Variables and handles the respective update event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_VARIABLES_UPDATE, onRoomVarsUpdate, this); * * // Create some Room Variables * var roomVars = []; * roomVars.push(new SFS2X.SFSRoomVariable("gameStarted", false)); * roomVars.push(new SFS2X.SFSRoomVariable("gameType", "Snooker")); * roomVars.push(new SFS2X.SFSRoomVariable("minRank", 10)); * * sfs.send(new SFS2X.SetRoomVariablesRequest(roomVars)); * } * * function onRoomVarsUpdate(evtParams) * { * var changedVars = evtParams.changedVars; * var room = evtParams.room; * * // Check if the "gameStarted" variable was changed * if (changedVars.indexOf("gameStarted") != -1) * { * if (room.getVariable("gameStarted") == true) * console.log("Game started"); * else * console.log("Game stopped"); * } * } */ static readonly ROOM_VARIABLES_UPDATE: string; /** * The userVariablesUpdate event type, dispatched when a User Variable is updated. * *

This event is caused by the SetUserVariablesRequest request sent by a user in one of the Rooms joined by the current user.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
user{@link SFSUser}An object representing the user who updated his own User Variables.
changedVarsArray of stringThe list of names of the User Variables that were changed (or created for the first time).
* @example * This example sets a number of User Variables and handles the respective update event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_VARIABLES_UPDATE, onUserVarsUpdate, this); * * // Create some User Variables * var userVars = []; * userVars.push(new SFS2X.SFSUserVariable("avatarType", "SwedishCook")); * userVars.push(new SFS2X.SFSUserVariable("country", "Sweden")); * userVars.push(new SFS2X.SFSUserVariable("x", 10)); * userVars.push(new SFS2X.SFSUserVariable("y", 5)); * * sfs.send(new SFS2X.SetUserVariablesRequest(userVars)); * } * * function onUserVarsUpdate(evtParams) * { * var changedVars = evtParams.changedVars; * var user = evtParams.user; * * // Check if the user changed his x and y user variables * if (changedVars.indexOf("x") != -1 || changedVars.indexOf("y") != -1) * { * // Move the user avatar to a new position * ... * } * } */ static readonly USER_VARIABLES_UPDATE: string; /** * The mmoItemVariablesUpdate event type, dispatched when an MMOItem Variable is updated in an MMORoom. * *

This event is caused by an MMOItem Variable being set, updated or deleted in a server side Extension, and it is received only if the current user * has the related MMOItem in his Area of Interest.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
room{@link MMORoom}The MMORoom where the MMOItem whose Variables have been updated is located.
mmoItem{@link MMOItem}The MMOItem whose variables have been updated.
changedVarsArray of stringThe list of names of the MMOItem Variables that were changed (or created for the first time).
* @example * This example shows how to handle the MMOItem Variable update. * function onMMOItemVarsUpdate(evtParams) * { * var changedVars = evtParams.changedVars; * var item = evtParams.mmoItem; * * // Check if the MMOItem was moved * if (changedVars.indexOf("x") != -1 || changedVars.indexOf("y") != -1) * { * // Move the sprite representing the MMOItem on screen * ... * } * } */ static readonly MMOITEM_VARIABLES_UPDATE: string; /** * The roomGroupSubscribe event type, dispatched when a Group is subscribed by the current user. * *

This event is fired in response to the SubscribeRoomGroupRequest> request if the operation is executed successfully.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
groupIdstringThe name of the Group that was subscribed.
newRoomsArray of {@link SFSRoom}A list of SFSRoom objects representing the Rooms belonging to the subscribed Group.
* @example * This example makes the current user subscribe a Group. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_SUBSCRIBE, onGroupSubscribed, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR, onGroupSubscribeError, this); * * // Subscribe the "cardGames" group * sfs.send(new SFS2X.SubscribeRoomGroupRequest("cardGames")); * } * * function onGroupSubscribed(evtParams) * { * console.log("Group subscribed. The following rooms are now accessible: " + evtParams.newRooms); * } * * function onGroupSubscribeError(evtParams) * { * console.log("Group subscription failed: " + evtParams.errorMessage); * } */ static readonly ROOM_GROUP_SUBSCRIBE: string; /** * The roomGroupSubscribeError event type, dispatched when an error occurs while a Room Group is being subscribed. * *

This event is fired in response to the SubscribeRoomGroupRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_GROUP_SUBSCRIBE constant description.

*/ static readonly ROOM_GROUP_SUBSCRIBE_ERROR: string; /** * The roomGroupUnsubscribe event type, dispatched when a Group is unsubscribed by the current user. * *

This event is fired in response to the UnsubscribeRoomGroupRequest request if the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
groupIdstringThe name of the Group that was unsubscribed.
* @example * This example makes the current user unsubscribe a Group. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_UNSUBSCRIBE, onGroupUnsubscribed, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR, onGroupUnsubscribeError, this); * * // Unsubscribe the "cardGames" group * sfs.send(new SFS2X.UnsubscribeRoomGroupRequest("cardGames")); * } * * function onGroupUnsubscribed(evtParams) * { * console.log("Group unsubscribed: " + evtParams.groupId); * } * * function onGroupUnsubscribeError(evtParams) * { * console.log("Group unsubscribing failed: " + evtParams.errorMessage); * } */ static readonly ROOM_GROUP_UNSUBSCRIBE: string; /** * The roomGroupUnsubscribeError event type, dispatched when an error occurs while a Room Group is being unsubscribed. * *

This event is fired in response to the UnsubscribeRoomGroupRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the ROOM_GROUP_UNSUBSCRIBE constant description.

*/ static readonly ROOM_GROUP_UNSUBSCRIBE_ERROR: string; /** * The roomFindResult event type, dispatched when a Rooms search is completed. * *

This event is fired in response to the FindRoomsRequest request to return the search result.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
roomsArray of {@link SFSRoom}A list of SFSRoom objects representing the Rooms matching the search criteria. If no Room is found, the list is empty.
* @example * This example looks for all the server Rooms whose "country" Room Variable is set to "Sweden". * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_FIND_RESULT, onRoomFindResult, this); * * // Create a matching expression to find Rooms with a "country" variable equal to "Sweden" * var exp = new SFS2X.MatchExpression("country", SFS2X.Entities.Match.StringMatch.EQUALS, "Sweden"); * * // Find the Rooms * sfs.send(new SFS2X.FindRoomsRequest(exp)); * } * * function onRoomFindResult(evtParams) * { * console.log("Rooms found: " + evtParams.rooms); * } */ static readonly ROOM_FIND_RESULT: string; /** * The userFindResult event type, dispatched when a users search is completed. * *

This event is fired in response to the FindUsersRequest request to return the search result.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
usersArray of {@link SFSUser}A list of SFSUser objects representing the users matching the search criteria. If no user is found, the list is empty.
* @example * This example looks for all the users whose "age" User Variable is greater than 29. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_FIND_RESULT, onUserFindResult, this); * * // Create a matching expression to find users with an "age" variable greater than 29: * var exp = new SFS2X.MatchExpression("age", SFS2X.NumberMatch.GREATER_THAN, 29); * * // Find the users * sfs.send(new SFS2X.FindUsersRequest(exp)); * } * * function onUserFindResult(evtParams) * { * console.log("Users found: " + evtParams.users); * } */ static readonly USER_FIND_RESULT: string; /** * The invitation event type, dispatched when the current user receives an invitation from another user. * *

This event is caused by the InviteUsersRequest and CreateSFSGameRequest requests; the user is supposed to reply using the InvitationReplyRequest request.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
invitation{@link SFSInvitation}An object representing the invitation received by the current user.
* @example * This example receives an invitation and accepts it automatically; in a real case scenario, the application interface usually allows the user choosing to accept or refuse the invitation, or even ignore it. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.INVITATION, onInvitationReceived, this); * sfs.addEventListener(SFS2X.SFSEvent.INVITATION_REPLY_ERROR, onInvitationReplyError, this); * } * * function onInvitationReceived(evtParams) * { * // Let's accept this invitation * sfs.send(new SFS2X.InvitationReplyRequest(evtParams.invitation, SFS2X.InvitationReply.ACCEPT)); * } * * function onInvitationReplyError(evtParams) * { * console.log("Failed to reply to invitation due to the following problem: " + evtParams.errorMessage); * } */ static readonly INVITATION: string; /** * The invitationReply event type, dispatched when the current user receives a reply to an invitation he sent previously. * *

This event is caused by the InvitationReplyRequest request sent by the invitee.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
invitee{@link SFSUser}An object representing the user who replied to the invitation.
replynumberThe answer to the invitation among those available as constants in the InvitationReply class.
data{@link SFSObject}A SFSObject containing custom parameters, for example a message describing the reason of refusal.
* *

See the example provided in the INVITATION constant description.

*/ static readonly INVITATION_REPLY: string; /** * The invitationReplyError event type, dispatched when an error occurs while the current user is sending a reply to an invitation he received. * *

This event is fired in response to the InvitationReplyRequest request in case the operation failed.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the INVITATION constant description.

*/ static readonly INVITATION_REPLY_ERROR: string; /** * The pingPong event type, dispatched when a new lag value measurement is available. * *

This event is fired when the automatic lag monitoring is turned on by passing true to the enableLagMonitor() method.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
lagValuenumberThe average of the last ten measured lag values, expressed in milliseconds.
*/ static readonly PING_PONG: string; /** * The socketError event type, dispatched when a low level socket error is detected, for example bad/inconsistent data. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringThe description of the error.
*/ static readonly SOCKET_ERROR: string; } /** * Developers never istantiate the SFSBuddyEvent class: only use its static properties. * *

The constants contained in this class are used to register the event listeners; when an event is dispatched, an object containing event-specific parameters is passed to the listener. * See the documentation below for a description of the parameters available for each event.

* @example * This example shows the approach to be implemented to listen to events; please refer to the specific event types for the parameters object content. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_LIST_INIT, onBuddyListInitialized, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this) * * // Initialize the Buddy List system * sfs.send(new SFS2X.InitBuddyListRequest()); * } * * function onBuddyListInitialized(evtParams) * { * console.log("Buddy List system initialized successfully"); * * // Retrieve my buddies list * var buddies = evtParams.buddyList; * * // Display the online buddies in a list component in the application interface * ... * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ export class SFSBuddyEvent { constructor(); /** * The buddyListInit event type, dispatched if the Buddy List system is successfully initialized. * *

This event is fired in response to the InitBuddyListRequest request in case the operation is executed successfully.

* *

After the Buddy List system initialization, the user returns to his previous custom state (if any - see SFSBuddyManager.getMyState() method). * His online/offline state, his nickname and his persistent Buddy Variables are all loaded and broadcast in the system. * In particular, the online state (see SFSBuddyManager.getMyOnlineState() method) determines if the user will appear online or not to other users who have him in their buddies list.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddyListArray of {@link SFSBuddy}A list of SFSBuddy objects representing all the buddies in the current user's buddy list.
myVariablesArray of {@link SFSBuddyVariable}A list of all the Buddy Variables associated with the current user.
* @example * This example initializes the Buddy List system. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_LIST_INIT, onBuddyListInitialized, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this) * * // Initialize the Buddy List system * sfs.send(new SFS2X.InitBuddyListRequest()); * } * * function onBuddyListInitialized(evtParams) * { * console.log("Buddy List system initialized successfully"); * * // Retrieve my buddies list * var buddies = evtParams.buddyList; * * // Display the online buddies in a list component in the application interface * ... * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ static readonly BUDDY_LIST_INIT: string; /** * The buddyAdd event type, dispatched when a buddy is added successfully to the current user's buddy list. * *

This event is fired in response to the AddBuddyRequest request in case the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object corresponding to the buddy that was added.
* @example * This example sends a request to add a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ADD, onBuddyAdded, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Add Jack as a new buddy to my buddies list * sfs.send(new SFS2X.AddBuddyRequest("Jack")); * } * * function onBuddyAdded(evtParams) * { * console.log("This buddy was added: " + evtParams.buddy.name); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ static readonly BUDDY_ADD: string; /** * The buddyRemove event type, dispatched when a buddy is removed successfully from the current user's buddy list. * *

This event is fired in response to the RemoveBuddyRequest request in case the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object corresponding to the buddy that was removed.
* @example * This example sends a request to remove a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_REMOVE, onBuddyRemoved, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Remove Jack from my buddies list * sfs.send(new SFS2X.RemoveBuddyRequest("Jack")); * } * * function onBuddyRemoved(evtParams) * { * console.log("This buddy was removed: " + evtParams.buddy.name); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ static readonly BUDDY_REMOVE: string; /** * The buddyBlock event type, dispatched when a buddy is blocked or unblocked successfully by the current user. * *

This event is fired in response to the BlockBuddyRequest request in case the operation is executed successfully.

* * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object corresponding to the buddy that was blocked/unblocked.
* @example * This example handles the possible events caused by a request to block a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_BLOCK, onBuddyBlock, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Block user "Jack" in my buddies list * smartFox.send(new SFS2X.BlockBuddyRequest("Jack", true)); * } * * function onBuddyBlock(evtParams) * { * var isBlocked = evtParams.buddy.isBlocked; * console.log("Buddy " + evtParams.buddy.name + " is now " + (isBlocked ? "blocked" : "unblocked")); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ static readonly BUDDY_BLOCK: string; /** * The buddyError event type, dispatched if an error occurs while executing a request related to the Buddy List system. * *

For example, this event is fired in response to the AddBuddyRequest request, the BlockBuddyRequest, etc.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
errorMessagestringA message containing the description of the error.
errorCodenumberThe error code.
* *

See the example provided in the BUDDY_ADD constant description.

*/ static readonly BUDDY_ERROR: string; /** * The buddyOnlineStateChange event type, dispatched when a buddy in the current user's buddy list changes his online state in the Buddy List system. * *

This event is fired in response to the GoOnlineRequest request.

* *

NOTE: this event is dispatched to those who have the user as a buddy, but also to the user himself. * As in this case the value of the buddy parameter is null (because the user is not buddy to himself of course), * the isItMe parameter should be used to check if the current user is the one who changed his own online state.

* * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object representing the buddy who changed his own online state. If the isItMe parameter is true, the value of this parameter is null (because a user is not buddy to himself).
isItMebooleantrue if the online state was changed by the current user himself (in this case this event is a sort of state change confirmation).
* @example * This example changes the online state of the user in the Buddy List system. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ONLINE_STATE_CHANGE, onBuddyOnlineStateChanged, this); * * // Put myself offline in the Buddy List system * sfs.send(new SFS2X.GoOnlineRequest(false)); * } * * function onBuddyOnlineStateChanged(evtParams) * { * // As the state change event is dispatched to me too, * // I have to check if I am the one who changed his state * * var isItMe = evtParams.isItMe; * * if (isItMe) * console.log("I'm now " + (sfs.buddyManager.getMyOnlineState() ? "online" : "offline")); * else * console.log("My buddy " + evtParams.buddy.name + " is now " + (evtParams.buddy.isOnline ? "online" : "offline")); * } */ static readonly BUDDY_ONLINE_STATE_CHANGE: string; /** * The buddyVariablesUpdate event type, dispatched when a buddy in the current user's buddies list updates one or more Buddy Variables. * *

This event is fired in response to the SetBuddyVariablesRequest request.

* *

NOTE: this event is dispatched to those who have the user as a buddy, but also to the user himself. * As in this case the value of the buddy parameter is null (because the user is not buddy to himself of course) and * the isItMe parameter should be used to check if the current user is the one who updated his own Buddy Variables.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object representing the buddy who updated his own Buddy Variables. If the isItMe parameter is true, the value of this parameter is null (because a user is not buddy to himself).
isItMebooleantrue if the Buddy Variables were updated by the current user himself (in this case this event is a sort of update confirmation).
changedVarsArray of stringThe list of names of the Buddy Variables that were changed (or created for the first time).
* @example * This example sets some Buddy Variables for the current user, one of which is persistent and another one is the reserved variable used to set the nickname; the example also handles changes made by the user or by his buddies. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE, onBuddyVarsUpdate, this); * * // Create two Buddy Variables containing the title and artist of the song I'm listening to * var songTitle = new SFS2X.SFSBuddyVariable("songTitle", "Ascension"); * var songAuthor = new SFS2X.SFSBuddyVariable("songAuthor", "Mike Oldfield"); * * // Create a persistent Buddy Variable containing my mood message * var mood = new SFS2X.SFSBuddyVariable(SFS2X.SFSBuddyVariable.OFFLINE_PREFIX + "mood", "SFS2X rocks!"); * * // Set my nickname * var nick = new SFS2X.SFSBuddyVariable(SFS2X.ReservedBuddyVariables.BV_NICKNAME, "Bax"); * * // Set my Buddy Variables * var vars = [songTitle, songAuthor, mood, nick]; * sfs.send(new SFS2X.SetBuddyVariablesRequest(vars)); * } * * function onBuddyVarsUpdate(evtParams) * { * // As the update event is dispatched to me too, * // I have to check if I am the one who changed his Buddy Variables * * var isItMe = evtParams.isItMe; * * if (isItMe) * { * console.log("I've updated the following Buddy Variables:"); * * for (var i = 0; i < evtParams.changedVars.length; i++) * { * var bVarName = evtParams.changedVars[i]; * console.log(bVarName + " -->; " + sfs.buddyManager.getMyVariable(bVarName).value); * } * } * else * { * var buddyName = evtParams.buddy.name; * * console.log("My buddy " + buddyName + " updated the following Buddy Variables:"); * * for (var i = 0; i < evtParams.changedVars.length; i++) * { * var bVarName = evtParams.changedVars[i]; * console.log(bVarName + " --> " + sfs.buddyManager.getBuddyByName(buddyName).getVariable(bVarName).value); * } * } * } */ static readonly BUDDY_VARIABLES_UPDATE: string; /** * The buddyMessage event type, dispatched when a message from a buddy is received by the current user. * *

This event is fired in response to the BuddyMessageRequest request.

* *

NOTE: the same event is fired by the sender's client too, so that the user is aware that the message was delivered successfully to the recipient, * and it can be displayed in the chat area keeping the correct message ordering. As in this case the value of the buddy parameter is null * (because, being the sender, the user is not buddy to himself of course), there is no default way to know who the message was originally sent to. * As this information can be useful in scenarios where the sender is chatting with more than one buddy at the same time in separate windows or tabs * (and we need to write his own message in the proper one), the data parameter can be used to store, for example, the id of the recipient buddy.

* * * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
buddy{@link SFSBuddy}The SFSBuddy object representing the message sender. If the isItMe parameter is true, the value of this parameter is null (because a user is not buddy to himself).
isItMebooleantrue if the message sender is the current user himself (in this case this event is a sort of message delivery confirmation).
messagestringThe message text.
data{@link SFSObject}A SFSObject containing additional custom parameters (e.g. the message color, an emoticon id, etc).
* @example * This example sends a message to a buddy and handles the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_MESSAGE, onBuddyMessage, this); * * // Get the recipient of the message, in this case my buddy Jack * var buddy = sfs.buddyManager.getBuddyByName("Jack"); * * // Send a message to Jack * sfs.send(new SFS2X.BuddyMessageRequest("Hello Jack!", buddy)); * } * * function onBuddyMessage(evtParams) * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var isItMe = evtParams.isItMe; * var sender = evtParams.buddy; * * if (isItMe) * console.log("I said: " + evtParams.message); * else * console.log("My buddy " + sender.name + " said: " + evtParams.message); * } */ static readonly BUDDY_MESSAGE: string; } /** * Developers never istantiate the SFSClusterEvent class: only use its static properties. * *

The constants contained in this class are used to register the event listeners; when an event is dispatched, an object containing event-specific parameters is passed to the listener. * See the documentation below for a description of the parameters available for each event.

* @example * This example shows the approach to be implemented to listen to events; please refer to the specific event types for the parameters object content. * function someMethod() * { * sfsLobby.addEventListener(SFS2X.SFSClusterEvent.CONNECTION_REQUIRED, onGameNodeConnectionRequired, this); * sfsLobby.addEventListener(SFS2X.SFSClusterEvent.LOAD_BALANCER_ERROR, onLoadBalancerError, this); * * // Set request parameters * ... * * // Send request * sfsLobby.send(new SFS2X.ClusterJoinOrCreateRequest(exp, group, settings)); * } * * function onGameNodeConnectionRequired(evtParams) * { * // Retrieve login details for later usage * gameUsername = evtParams.userName; * gamePassword = evtParams.password; * * // Initialize SmartFox client used to connect to the cluster game node * sfsGame = new SFS2X.SmartFox(); * * // Add event listeners * ... * * // Establish a connection to the game node; a game room will be joined automatically after login * sfsGame.connect(evtParams.configObj); * } * * function onLoadBalancerError(evtParams) * { * console.log("A load balancer error occurred: you should investigate the cluster state"); * } */ export class SFSClusterEvent { constructor(); /** * The connectionRequired event type, dispatched when the Lobby has found a Game Node for the client to join in a SmartFoxServer 2X Cluster. * *

This event is fired when the Lobby signals that the client should join a given Game Node, in response to a ClusterJoinOrCreateRequest request or when an invitation to join an existing game on a Game Node is accepted by the invited user.

* * * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
configObjobjectThe pre-populated client configuration object to start a new connection towards the designated Game Node.
userNamestringThe user name to access the Game Node.
passwordstringA temporary and unique password to access the Game Node.
* @example * This example shows how to attempt a connection to a Game Node when the event is received. * function someMethod() * { * sfsLobby.addEventListener(SFS2X.SFSClusterEvent.CONNECTION_REQUIRED, onGameNodeConnectionRequired, this); * } * * function onGameNodeConnectionRequired(evtParams) * { * // Retrieve connection settings * var config = evtParams.configObj; * * // Retrieve login details for later usage * gameUsername = evtParams.userName; * gamePassword = evtParams.password; * * // Initialize SmartFox client used to connect to the cluster game node * sfsGame = new SFS2X.SmartFox(); * * // Add event listeners * sfsGame.addEventListener(SFS2X.SFSEvent.CONNECTION, onGameNodeConnection, this); * sfsGame.addEventListener(SFS2X.SFSEvent.LOGIN, onGameNodeLogin, this); * sfsGame.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onGameRoomJoin, this); * * // Establish a connection to the game node; a game room will be joined automatically after login * sfsGame.connect(config); * } */ static readonly CONNECTION_REQUIRED: string; /** * The loadBalancerError event type, dispatched when a cluster-related request cannot be satisfied, typically creating or joining a game in a SmartFoxServer 2X Cluster. * *

For example, this event can be fired in response to the ClusterJoinOrCreateRequest request.

* *

The event does not provide further details as the Load Balancer simply queries the available servers and if none is found matching the contextual criteria, the cluster request cannot be completed.

* @example * This example shows how to handle this event type. * function someMethod() * { * sfsLobby.addEventListener(SFS2X.SFSClusterEvent.LOAD_BALANCER_ERROR, onLoadBalancerError, this); * } * * function onLoadBalancerError(evtParams) * { * console.log("A load balancer error occurred: you should investigate the cluster state"); * } */ static readonly LOAD_BALANCER_ERROR: string; } /** * Developers never istantiate the SFSDataType class: only use its static properties. */ export class SFSDataType { constructor(); /** * A null value. */ static readonly NULL: number; /** * A boolean value. */ static readonly BOOL: number; /** * A byte (8 bit) value. */ static readonly BYTE: number; /** * A short integer (16 bit) value. */ static readonly SHORT: number; /** * An integer (32 bit) value. */ static readonly INT: number; /** * A long integer value. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * So if you are developing your server side Extension in Java, make sure you take this limitation into account when dealing with integers.

*/ static readonly LONG: number; /** * A floating point number (32 bit) value. */ static readonly FLOAT: number; /** * A double precision number (64 bit) value. */ static readonly DOUBLE: number; /** * A UTF-8 encoded string value, with length up to 32 KBytes. */ static readonly UTF_STRING: number; /** * An array of boolean values. */ static readonly BOOL_ARRAY: number; /** * An array of byte values. */ static readonly BYTE_ARRAY: number; /** * An array of short integer values. */ static readonly SHORT_ARRAY: number; /** * A short integer (16 bit) value. */ static readonly INT_ARRAY: number; /** * An array of long integer values. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * So if you are developing your server side Extension in Java, make sure you take this limitation into account when dealing with integers.

*/ static readonly LONG_ARRAY: number; /** * An array of floating point number values. */ static readonly FLOAT_ARRAY: number; /** * An array of double precision number values. */ static readonly DOUBLE_ARRAY: number; /** * An array of string values. */ static readonly UTF_STRING_ARRAY: number; /** * A nested SFSArray object. */ static readonly SFS_ARRAY: number; /** * A nested SFSObject object. */ static readonly SFS_OBJECT: number; /** * A UTF-8 encoded string value, with length up to 2 GBytes. */ static readonly TEXT: number; } /** * Creates a new SFSObject instance. * *

This is a sort of specialized map object that can contain any type of data. The advantage of using the SFSObject class * (for example when sending an ExtensionRequest request) is that you can fine tune the way your data is transmitted over the network. * For instance, a number like 100 can be transmitted as a normal integer (which takes 32 bits), but also a short (16 bit) or even a byte (8 bit).

* *

SFSObject supports many primitive data types and related arrays of primitives; see the SFSDataType class.

* *

NOTE: UTF-8/multi-byte strings are not supported in key names. In other words you should restrict key names to standard ASCII characters. It is also recommended to keep key names very short to save bandwidth.

*/ export class SFSObject { /** * Retrieves a list of all the keys contained in this object. * @returns The list of all the keys in this object. */ getKeysArray(): string[]; /** * Returns the number of elements in this object. * @returns The number of elements in this object. */ size(): number; /** * Indicates whether this object contains a mapping for the specified key. * @param key - The key whose presence in this object is to be checked. * @returns true if this object contains a mapping for the passed key. */ containsKey(key: string): boolean; /** * Returns the value assigned to the specified key. * *

If the typeId parameter is passed, this method also executes a type check, to make sure the requested value has the expected type. * In particular this is used by the other specialized get...() methods.

* @param key - The key whose associated value is to be returned. * @param [typeId = null] - The identifier of the expected value's type; must be one of the constants set in the SFSDataType class. *
If passed and the type is not corresponding, an error is thrown. *
If not passed, no type check is executed and the value is returned immediately. * @returns The value assigned to the specified key. null is returned if no value is associated with the passed key. */ get(key: string, typeId?: number): any; /** * Indicates if the value mapped by the passed key is of type SFSDataType.NULL. * @param key - The key to be checked. * @returns true if the value mapped by the passed key is of type SFSDataType.NULL. */ isNull(key: string): boolean; /** * Returns the boolean value corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getBool(key: string): boolean; /** * Returns the byte value corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getByte(key: string): number; /** * Returns the short integer corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getShort(key: string): number; /** * Returns the integer corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getInt(key: string): number; /** * Returns the long integer corresponding to the passed key. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * In case a number greater than {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} is returned, this could differ from the actual value set on the server side (a warning will be logged on the client).

* @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getLong(key: string): number; /** * Returns the floating point number corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getFloat(key: string): number; /** * Returns the double precision number corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getDouble(key: string): number; /** * Returns the UTF-8 string corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getUtfString(key: string): string; /** * Returns the UTF-8 string corresponding to the passed key. * @param key - The key whose associated value is to be returned. * @returns The value assigned to the specified key. */ getText(key: string): string; /** * Returns the array of boolean values corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getBoolArray(key: string): any[]; /** * Returns the byte array corresponding to the passed key. * @param key - The key whose associated byte array is to be returned. * @returns The byte array assigned to the specified key. */ getByteArray(key: string): Uint8Array; /** * Returns the array of short integers corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getShortArray(key: string): any[]; /** * Returns the array of integers corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getIntArray(key: string): any[]; /** * Returns the array of long integers corresponding to the passed key. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1.

* @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getLongArray(key: string): any[]; /** * Returns the array of floating point numbers corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getFloatArray(key: string): any[]; /** * Returns the array of double precision numbers corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getDoubleArray(key: string): any[]; /** * Returns the array of UTF-8 strings corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The array assigned to the specified key. */ getUtfStringArray(key: string): any[]; /** * Returns the SFSObject corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The SFSObject assigned to the specified key. */ getSFSObject(key: string): SFSObject; /** * Returns the SFSArray corresponding to the passed key. * @param key - The key whose associated array is to be returned. * @returns The SFSArray assigned to the specified key. */ getSFSArray(key: string): SFSArray; /** * Assign a value of the passed type to the passed key. * @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. * @param typeId - The value's type identifier; must be one of the constants set in the SFSDataType class. */ put(key: string, value: any, typeId: number): void; /** * Assigns a null value to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. */ putNull(key: string): void; /** * Assigns a boolean value to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putBool(key: string, value: boolean): void; /** * Assigns a number to the passed key as a byte (8 bit). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putByte(key: string, value: number): void; /** * Assigns a number to the passed key as a short integer (16 bit). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putShort(key: string, value: number): void; /** * Assigns a number to the passed key as an integer (32 bit). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putInt(key: string, value: number): void; /** * Assigns a number to the passed key as a long integer. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * So if you are developing your server side Extension in Java, make sure you take this limitation into account when dealing with integers.

* *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putLong(key: string, value: number): void; /** * Assigns a number to the passed key as a floating point value (32 bit). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putFloat(key: string, value: number): void; /** * Assigns a number to the passed key as a double precision value (64 bit). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putDouble(key: string, value: number): void; /** * Assigns a UTF-8 string to the passed key (max length: 32 KBytes). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putUtfString(key: string, value: string): void; /** * Assigns a UTF-8 text to the passed key (max length: 2 GBytes). * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The value to be assigned to the passed key. */ putText(key: string, value: string): void; /** * Assigns an array of booleans to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putBoolArray(key: string, array: boolean[]): void; /** * Assigns a byte array to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified byte array has to be assigned. * @param array - The byte array to be assigned to the passed key. */ putByteArray(key: string, array: Uint8Array): void; /** * Assigns an array of numbers to the passed key as short integers. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putShortArray(key: string, array: number[]): void; /** * Assigns an array of numbers to the passed key as integers. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putIntArray(key: string, array: number[]): void; /** * Assigns an array of numbers to the passed key as long integers. * *

This is a shortcut for the put() method.

* *

Read important note in the put() method description.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putLongArray(key: string, array: number[]): void; /** * Assigns an array of numbers to the passed key as floating point values. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putFloatArray(key: string, array: number[]): void; /** * Assigns an array of numbers to the passed key as double precision values. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putDoubleArray(key: string, array: number[]): void; /** * Assigns an array of UTF-8 strings to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified array has to be assigned. * @param array - The array to be assigned to the passed key. */ putUtfStringArray(key: string, array: string[]): void; /** * Assigns a nested SFSArray to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The SFSArray to be assigned to the passed key. */ putSFSArray(key: string, value: SFSArray): void; /** * Assigns a nested SFSObject to the passed key. * *

This is a shortcut for the put() method.

* @param key - The key to which the specified value has to be assigned. * @param value - The SFSObject to be assigned to the passed key. */ putSFSObject(key: string, value: SFSObject): void; /** * Provides a formatted string representing this object. * *

The returned string can be logged or traced in the console for debugging purposes.

* @param [format = true] - If true, the output is formatted in a human-readable way. * @returns The string representation of this object. */ getDump(format?: boolean): string; /** * Provides a detailed hexadecimal representation of this object. * *

The returned string can be logged or traced in the console for debugging purposes.

* @returns The hexadecimal string representation of this object. */ getHexDump(): string; } /** * Creates a new SFSArray instance. * *

This is a sort of specialized list object that can contain any type of data. The advantage of using the SFSArray class * (for example as a nested object inside a SFSObject object) is that you can fine tune the way your data is transmitted over the network. * For instance, when transmitting a list of numbers between 0 and 100, those values can be treated as normal integers (which take 32 bits each), but also as shorts (16 bit) or even as bytes (8 bit).

* *

SFSArray supports many primitive data types and related arrays of primitives; see the SFSDataType class.

*/ export class SFSArray { /** * Indicates the number of elements in this array. * @returns The number of elements in this array. */ size(): number; /** * Indicates whether this SFSArray contains the specified object or not. * *

NOTE: this method doesn't support checking the presence of a nested SFSObject or SFSArray.

* @param object - The object whose presence in this array is to be tested. * @returns true if the specified object is present in the SFSArray. */ contains(object: any): boolean; /** * Returns the element at the specified index. * *

If the typeId parameter is passed, this method also executes a type check, to make sure the requested value has the expected type. * In particular this is used by the other specialized get...() methods.

* @param index - The position of the element to return. * @param [typeId = null] - The identifier of the expected value's type; must be one of the constants set in the SFSDataType class. *
If passed and the type is not corresponding, an error is thrown. *
If not passed, no type check is executed and the value is returned immediately. * @returns The element of this array at the specified index. */ get(index: number, typeId?: number): any; /** * Indicates if the element at the specified index is of type SFSDataType.NULL. * @param index - The position of the element to be checked. * @returns true if the element at the specified index is of type SFSDataType.NULL. */ isNull(index: number): boolean; /** * Returns the boolean value at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getBool(index: number): boolean; /** * Returns the byte value at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getByte(index: number): number; /** * Returns the short integer at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getShort(index: number): number; /** * Returns the integer at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getInt(index: number): number; /** * Returns the long at the specified index. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * In case a number greater than {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} is returned, this could differ from the actual value set on the server side (a warning will be logged on the client).

* @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getLong(index: number): number; /** * Returns the floating point number at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getFloat(index: number): number; /** * Returns the double precision number at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getDouble(index: number): number; /** * Returns the UTF-8 string at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getUtfString(index: number): string; /** * Returns the UTF-8 string at the specified index. * @param index - The position of the element to return. * @returns The element of this array at the specified index. */ getText(index: number): string; /** * Returns the array of boolean values at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getBoolArray(index: number): any[]; /** * Returns the byte array at the specified index. * @param index - The position of the byte array to return. * @returns The byte array at the specified index. */ getByteArray(index: number): Uint8Array; /** * Returns the array of short integers at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getShortArray(index: number): any[]; /** * Returns the array of integers at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getIntArray(index: number): any[]; /** * Returns the array of long integers at the specified index. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1.

* @param index - The position of the array to return. * @returns The array at the specified index. */ getLongArray(index: number): any[]; /** * Returns the array of floating point numbers at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getFloatArray(index: number): any[]; /** * Returns the array of double precision numbers at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getDoubleArray(index: number): any[]; /** * Returns the array of UTF-8 strings at the specified index. * @param index - The position of the array to return. * @returns The array at the specified index. */ getUtfStringArray(index: number): any[]; /** * Returns the SFSObject at the specified index. * @param index - The position of the array to return. * @returns The SFSObject at the specified index. */ getSFSObject(index: number): SFSObject; /** * Returns the SFSArray at the specified index. * @param index - The position of the array to return. * @returns The SFSArray at the specified index. */ getSFSArray(index: number): SFSArray; /** * Appends a value of the passed type to the end of this array. * @param value - The value to be appended to this array. * @param typeId - The value's type identifier; must be one of the constants set in the SFSDataType class. */ add(value: any, typeId: number): void; /** * Appends a null value to the end of this array. * *

This is a shortcut for the add() method.

*/ addNull(): void; /** * Appends a boolean value to the end of this array. * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addBool(value: boolean): void; /** * Appends a number to the end of this array as a byte (8 bit). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addByte(value: number): void; /** * Appends a number to the end of this array as a short integer (16 bit). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addShort(value: number): void; /** * Appends a number to the end of this array as an integer (32 bit). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addInt(value: number): void; /** * Appends a number to the end of this array as a long integer. * *

IMPORTANT: in JavaScript, long integer numbers are limited to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER Number.MAX_SAFE_INTEGER} (positive and negative, inclusive). * This is inconsistent with the max and min Long values available in Java, which are down to -2^63 and up to 2^63 - 1. * So if you are developing your server side Extension in Java, make sure you take this limitation into account when dealing with integers.

* *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addLong(value: number): void; /** * Appends a number to the end of this array as a floating point value (32 bit). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addFloat(value: number): void; /** * Appends a number to the end of this array as a double precision value (64 bit). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addDouble(value: number): void; /** * Appends a UTF-8 string to the end of this array (max length: 32 KBytes). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addUtfString(value: string): void; /** * Appends a UTF-8 string to the end of this array (max length: 2 GBytes). * *

This is a shortcut for the add() method.

* @param value - The value to be appended to this array. */ addText(value: string): void; /** * Appends an array of booleans to the end of this array. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addBoolArray(array: boolean[]): void; /** * Appends a byte array to the end of this array. * *

This is a shortcut for the add() method.

* @param array - The byte array to be appended to this array. */ addByteArray(array: Uint8Array): void; /** * Appends an array of numbers to the end of this array as short integers. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addShortArray(array: number[]): void; /** * Appends an array of numbers to the end of this array as integers. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addIntArray(array: number[]): void; /** * Appends an array of numbers to the end of this array as long integers. * *

This is a shortcut for the add() method.

* *

Read important note in the add() method description.

* @param array - The array to be appended to this array. */ addLongArray(array: number[]): void; /** * Appends an array of numbers to the end of this array as floating point values. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addFloatArray(array: number[]): void; /** * Appends an array of numbers to the end of this array as double precision values. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addDoubleArray(array: number[]): void; /** * Appends an array of UTF-8 strings to the end of this array. * *

This is a shortcut for the add() method.

* @param array - The array to be appended to this array. */ addUtfStringArray(array: string[]): void; /** * Appends a nested SFSArray to the end of this array. * *

This is a shortcut for the add() method.

* @param value - The SFSArray to be appended to this array. */ addSFSArray(value: SFSArray): void; /** * Appends a nested SFSObject to the end of this array. * *

This is a shortcut for the add() method.

* @param value - The SFSObject to be appended to this array. */ addSFSObject(value: SFSObject): void; /** * Provides a formatted string representing this array. * *

The returned string can be logged or traced in the console for debugging purposes.

* @param [format = true] - If true, the output is formatted in a human-readable way. * @returns The string representation of this array. */ getDump(format?: boolean): string; /** * Provides a detailed hexadecimal representation of this array. * *

The returned string can be logged or traced in the console for debugging purposes.

* @returns The hexadecimal string representation of this array. */ getHexDump(): string; } /** * Creates a new Vec3D instance. * *

The position along the Z axis is optional for 2D environments.

* *

The useFloats parameter can be used to force the API send the coordinates as floating point values * when setting the user position (see the SetUserPositionRequest request) or creating an MMORoom.
* This must be set accordingly to the server side setting of the MMORoom and consistently through the client.

* @param px - The position along the X axis. * @param py - The position along the Y axis. * @param [pz = 0] - The position along the Z axis. * @param [useFloats = false] - Force the coordinates to be sent as floating point values to the server. */ export class Vec3D { constructor(px: number, py: number, pz?: number, useFloats?: boolean); /** * Returns the position along the X axis. */ px: number; /** * Returns the position along the Y axis. */ py: number; /** * Returns the position along the Z axis. */ pz: number; } /** * Developers never istantiate an SFSInvitation class: always use the reference to an existing instance provided by the invitation event.

* *

An invitation is sent through the InviteUsersRequest request and it is received as an invitation event. * Clients can reply to an invitation using the InvitationReplyRequest request.

*/ export class SFSInvitation { /** * Indicates the id of the invitation. * It is generated by the server when the invitation is sent. */ readonly id: number; /** * Returns the SFSUser object corresponding to the user who sent the invitation. */ readonly inviter: SFSUser; /** * Returns the SFSUser object corresponding to the user who received the invitation. */ readonly invitee: SFSUser; /** * Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires. */ readonly secondsForAnswer: number; /** * Returns a SFSObject containing a custom set of parameters. * It usually stores invitation details, like a message to the invitee and any other relevant data. */ readonly params: SFSObject; } /** * The possible replies to an invitation. */ export class InvitationReply { constructor(); /** * Invitation is accepted. */ static readonly ACCEPT: number; /** * Invitation is refused. */ static readonly REFUSE: number; /** * Invitation expired. */ static readonly EXPIRED: number; } /** * Developers never istantiate the Matcher class: this is done internally by the SmartFoxServer 2X API. */ export class Matcher { /** * Returns the type id of this matcher. */ readonly type: number; /** * Returns the condition symbol of this matcher. */ readonly symbol: string; } /** * Developers never istantiate the BoolMatch class: only use its static properties. */ export class BoolMatch extends Matcher { /** * An instance of BoolMatch representing the following condition: bool1 == bool2. */ static readonly EQUALS: BoolMatch; /** * An instance of BoolMatch representing the following condition: bool1 != bool2. */ static readonly NOT_EQUALS: BoolMatch; /** * Returns the type id of this matcher. */ readonly type: number; /** * Returns the condition symbol of this matcher. */ readonly symbol: string; } /** * Developers never istantiate the NumberMatch class: only use its static properties. */ export class NumberMatch extends Matcher { /** * An instance of NumberMatch representing the following condition: number1 == number2. */ static readonly EQUALS: NumberMatch; /** * An instance of NumberMatch representing the following condition: number1 != number2. */ static readonly NOT_EQUALS: NumberMatch; /** * An instance of NumberMatch representing the following condition: number1 > number2. */ static readonly GREATER_THAN: NumberMatch; /** * An instance of NumberMatch representing the following condition: number1 >= number2. */ static readonly GREATER_THAN_OR_EQUAL_TO: NumberMatch; /** * An instance of NumberMatch representing the following condition: number1 < number2. */ static readonly LESS_THAN: NumberMatch; /** * An instance of NumberMatch representing the following condition: number1 <= number2. */ static readonly LESS_THAN_OR_EQUAL_TO: NumberMatch; /** * Returns the type id of this matcher. */ readonly type: number; /** * Returns the condition symbol of this matcher. */ readonly symbol: string; } /** * Developers never istantiate the StringMatch class: only use its static properties. */ export class StringMatch extends Matcher { /** * An instance of StringMatch representing the following condition: string1 == string2. */ static readonly EQUALS: StringMatch; /** * An instance of StringMatch representing the following condition: string1 != string2. */ static readonly NOT_EQUALS: StringMatch; /** * An instance of StringMatch representing the following condition: string1.indexOf(string2) != -1. */ static readonly CONTAINS: StringMatch; /** * An instance of StringMatch representing the following condition: string1 starts with characters contained in string2. */ static readonly STARTS_WITH: StringMatch; /** * An instance of StringMatch representing the following condition: string1 ends with characters contained in string2. */ static readonly ENDS_WITH: StringMatch; /** * Returns the type id of this matcher. */ readonly type: number; /** * Returns the condition symbol of this matcher. */ readonly symbol: string; } /** * Creates a new MatchExpression instance. * *

Matching expression are used to compare custom variables or predefined properties when searching for users or Rooms. They are built like "if" statements in any common programming language. * They work like queries in a database and can be used to search for Rooms or users using custom criteria: in fact a matching expression can compare predefined * properties of the Room and user entities (see the RoomProperties and UserProperties classes), but also custom Room or User Variables.

* *

These expressions are easy to create and concatenate, and they can be used for many different filtering operations within the SmartFoxServer 2X framework, * for example to invite players to join a game (see the CreateSFSGameRequest request description), to look for specific Rooms * or users (see the FindRoomsRequest and FindUsersRequest requests descriptions), etc.

* *

Additionally:

* * @example * This example shows how to create a simple matching expression made of two concatenated conditions: it compares the custom "rank" and "country" User Variables to the passed values. This expression could be used during the creation of a Game Room, to filter the users that the server should take into account when sending the invitations to join the game (only italian users with a ranking greater than 5 - whatever this number means to our game). * var exp = new SFS2X.MatchExpression('rank', SFS2X.NumberMatch.GREATER_THAN, 5) * .and('country', SFS2X.StringMatch.EQUALS, 'Italy'); * @example * This example creates a matching expression made of three concatenated conditions which compare two predefined Room properties and the custom "isGameStarted" Room Variable to the passed values; this expression could be used to retrieve all the Game Rooms still waiting for players to join them. * var exp = new SFS2X.MatchExpression(SFS2X.RoomProperties.IS_GAME, SFS2X.BoolMatch.EQUALS, true) * .and(SFS2X.RoomProperties.HAS_FREE_PLAYER_SLOTS, SFS2X.BoolMatch.EQUALS, true) * .and('isGameStarted', SFS2X.BoolMatch.EQUALS, false); * @example * This example creates a matching expression which compares a nested property in a complex data structure; an object called "avatarData" (could be a User Variable for example) contains the "shield" object (a nested object) which in turn contains, among others, the "inUse" property which could be used to retrieve all user whose avatars are currently equipped with a shield. * var exp = new SFS2X.MatchExpression('avatarData.shield.inUse', SFS2X.BoolMatch.EQUALS, true); * @example * This example is similar to the previous one, but it involves an array. The "avatarData" object contains the "weapons" array, from which the expression retrieves the third element (that ".3" means "give me the element at index == 3") that we know being the weapon the user avatar has in his right hand. Again, this element is an object containing, among the others, the "name" property which can be compared to the passed string. This example could be used to retrieve all users whose avatars have the Narsil sword in the right hand. * var exp = new SFS2X.MatchExpression('avatarData.weapons.3.name', SFS2X.StringMatch.EQUALS, "Narsil"); * @param varName - The name of the variable or property to match. * @param condition - A matching condition among those provided by the BoolMatch, NumberMatch and StringMatch classes. * @param value - The value to compare against the variable or property during the matching. */ export class MatchExpression { constructor(varName: string, condition: Matcher, value: boolean | number | string); /** * Returns the name of the variable or property against which the comparison is made. * *

Depending what the matching expression is used for (searching a user or a Room), this can be * the name of a User Variable or a Room Variable, or it can be one of the constants contained in the UserProperties or RoomProperties classes, representing some of the predefined properties of the user and Room entities respectively.

*/ readonly varName: string; /** * Returns the matching criteria used during values comparison among those provided by the BoolMatch, NumberMatch and StringMatch classes. */ readonly condition: Matcher; /** * Returns the value against which the variable or property corresponding to varName is compared. */ readonly value: any; /** * In case of concatenated expressions, returns the current logical operator. */ readonly logicOp: LogicOperator; /** * Returns the next matching expression concatenated to the current one, if existing. */ readonly next: MatchExpression; /** * Concatenates the current expression with a new one using the logical AND operator. * @param varName - Name of the additional variable or property to match. * @param condition - The additional matching condition among those provided by the BoolMatch, NumberMatch and StringMatch classes. * @param value - The value to compare against the additional variable or property during the matching. * @returns A new MatchExpression resulting from the concatenation of the current expression with a new one generated from the specified parameters. */ and(varName: string, condition: Matcher, value: boolean | number | string): MatchExpression; /** * Concatenates the current expression with a new one using the logical OR operator. * @param varName - Name of the additional variable or property to match. * @param condition - The additional matching condition among those provided by the BoolMatch, NumberMatch and StringMatch classes. * @param value - The value to compare against the additional variable or property during the matching. * @returns A new MatchExpression resulting from the concatenation of the current expression with a new one generated from the specified parameters. */ or(varName: string, condition: Matcher, value: boolean | number | string): MatchExpression; /** * Checks if the current matching expression is concatenated to another one through a logical operator. * @returns true if the current matching expression is concatenated to another one. */ hasNext(): boolean; /** * Moves the iterator cursor to the first matching expression in the chain. * @returns The MatchExpression object at the top of the chain of matching expressions. */ rewind(): MatchExpression; /** * Returns a string representation of the matching expression. * @returns The string representation of the MatchExpression object. */ toString(): string; } /** * Developers never istantiate the LogicOperator class: only use its static properties. */ export class LogicOperator { /** * Returns the id of the current LogicOperator instance. * It can be the string "AND" or "OR". */ readonly id: string; /** * An instance of LogicOperator representing the AND logical operator. */ static readonly AND: LogicOperator; /** * An instance of LogicOperator representing the OR logical operator. */ static readonly OR: LogicOperator; } /** * Developers never istantiate the RoomProperties class: only use its static properties. */ export class RoomProperties { constructor(); /** * The Room name. *

Requires a StringMatch instance to be used for values comparison.

*/ static readonly NAME: string; /** * The name of the Group to which the Room belongs. *

Requires a StringMatch instance to be used for values comparison.

*/ static readonly GROUP_ID: string; /** * The maximum number of users allowed in the Room (players in Game Rooms). *

Requires a NumberMatch instance to be used for values comparison.

*/ static readonly MAX_USERS: string; /** * The maximum number of spectators allowed in the Room (Game Rooms only). *

Requires a NumberMatch instance to be used for values comparison.

*/ static readonly MAX_SPECTATORS: string; /** * The Room users count (players in Game Rooms). *

Requires a NumberMatch instance to be used for values comparison.

*/ static readonly USER_COUNT: string; /** * The Room spectators count (Game Rooms only). *

Requires a NumberMatch instance to be used for values comparison.

*/ static readonly SPECTATOR_COUNT: string; /** * The Room is a Game Room. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_GAME: string; /** * The Room is private. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_PRIVATE: string; /** * The Room has at least one free player slot. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly HAS_FREE_PLAYER_SLOTS: string; /** * The Room is an SFSGame on the server-side. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_TYPE_SFSGAME: string; /** * The Room is an MMORoom on the server-side. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_TYPE_MMO: string; /** * The Room is of default type on the server-side. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_TYPE_DEFAULT: string; } /** * Developers never istantiate the UserProperties class: only use its static properties. */ export class UserProperties { constructor(); /** * The Room name. *

Requires a StringMatch instance to be used for values comparison.

*/ static readonly NAME: string; /** * The user is a player in a Game Room. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_PLAYER: string; /** * The user is a spectator in a Game Room. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_SPECTATOR: string; /** * The user is a Non-Player Character (NPC). *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_NPC: string; /** * The user privilege id. *

Requires a NumberMatch instance to be used for values comparison.

*/ static readonly PRIVILEGE_ID: string; /** * The user joined at least one Room. *

Requires a BoolMatch instance to be used for values comparison.

*/ static readonly IS_IN_ANY_ROOM: string; } /** * Developers never istantiate the SFSBuddy class: this is done internally by the SmartFoxServer 2X API. * *

A buddy is marked out by the following characteristics:

* */ export class SFSBuddy { /** * Indicates the id of this buddy. * This is equal to the id assigned by SmartFoxServer to the corresponding user. */ readonly id: number; /** * Indicates the name of this buddy. * This is equal to the name of the corresponding user. */ readonly name: string; /** * Indicates whether this buddy is blocked in the current user's buddy list or not. * A buddy can be blocked by means of a BlockBuddyRequest request. */ readonly isBlocked: boolean; /** * Indicates whether this buddy is temporary (non-persistent) in the current user's buddy list or not. */ readonly isTemp: boolean; /** * Indicates whether this buddy is online in the Buddy List system or not. */ readonly isOnline: boolean; /** * Returns the custom state of this buddy. * Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state is not set, null is returned. * *

The list of available custom states is returned by the SFSBuddyManager.getBuddyStates() method.

*/ readonly state: string; /** * Returns the nickname of this buddy. * If the nickname is not set, null is returned. */ readonly nickName: string; /** * Returns a string that contains the buddy id and name. * @returns The string representation of the SFSBuddy object. */ toString(): string; /** * Retrieves a Buddy Variable from its name. * @param varName - The name of the Buddy Variable to be retrieved. * @returns The object representing the Buddy Variable, or undefined if no Buddy Variable with the passed name is associated to this buddy. */ getVariable(varName: string): SFSBuddyVariable; /** * Indicates whether this user has the specified Buddy Variable set or not. * @param varName - The name of the Buddy Variable whose existance must be checked. * @returns true if a Buddy Variable with the passed name is set for this buddy. */ containsVariable(varName: string): boolean; /** * Retrieves all the Buddy Variables of this user. * @returns The list of SFSBuddyVariable objects associated to the buddy. */ getVariables(): SFSBuddyVariable[]; /** * Retrieves the list of persistent Buddy Variables for this buddy. * @returns A list of SFSBuddyVariable objects corresponding to the buddy's persistent Buddy Variables. */ getOfflineVariables(): SFSBuddyVariable[]; /** * Retrieves the list of non-persistent Buddy Variables for this buddy. * @returns A list of SFSBuddyVariable objects corresponding to the buddy's non-persistent Buddy Variables. */ getOnlineVariables(): SFSBuddyVariable[]; } /** * Developers never istantiate the MMOItem class: this is done internally by the SmartFoxServer 2X API. * *

MMOItems can be used to represent bonuses, triggers, bullets, etc, or any other non-player entity that will be handled using the MMORoom's rules of visibility. * This means that whenever one or more MMOItems fall within the Area of Interest of a user, their presence will be notified to that user by means of the * proximityListUpdate event.

*

MMOItems are identified by a unique ID and can have one or more MMOItem Variables associated to store custom data.

*/ export class MMOItem { /** * Indicates the id of this item. * The id is unique and it is generated by the server when the MMOItem is created. */ readonly id: number; /** * Returns the entry point of this item in the current user's AoI. * *

The returned coordinates are those that the item had when its presence in the current user's Area of Interest was last notified by a proximityListUpdate event. * This field is populated only if the MMORoom in which the item exists is configured to receive such data.

*/ readonly aoiEntryPoint: Vec3D; /** * Returns a string that contains the item id. * @returns The string representation of the MMOItem object. */ toString(): string; /** * Retrieves an MMOItem Variable from its name. * @param varName - The name of the MMOItem Variable to be retrieved. * @returns The MMOItemVariable object, or undefined if no MMOItem Variable with the passed name is associated to this item. */ getVariable(varName: string): MMOItemVariable; /** * Indicates whether this item has the specified MMOItem Variable set or not. * @param varName - The name of the MMOItem Variable whose existance must be checked. * @returns true if an MMOItem Variable with the passed name is set for this item. */ containsVariable(varName: string): boolean; /** * Retrieves all the MMOItem Variables of this item. * @returns The list of MMOItemVariable objects associated to this item. */ getVariables(): MMOItemVariable[]; } /** * Developers never istantiate the SFSRoom class: this is done internally by the SmartFoxServer 2X API. * *

The Room is the basic structure used to group users connected to SmartFoxServer 2X. * The client API is not aware of all the Rooms existing on the server side, * but only of those that are joined by the user and those in the Room Groups that have been subscribed. * Subscribing to one or more Groups allows the client to listen to Room events in specific "areas" of the Zone, * without having to retrieve and keep synchronized the details of all available Rooms, thus reducing * the traffic between the client and the server considerably.

* *

The list of available Rooms is created after a successful login and it is kept updated continuously by the server.

*/ export class SFSRoom { /** * Defines a generic utility object that can be used to store custom Room data. * The values added to this object are for client-side use only and are never transmitted to the server or to the other clients. */ properties: any; /** * Indicates the id of this Room. * The id is unique and it is generated by the server when the Room is created. */ readonly id: number; /** * Indicates the name of this Room. * Two Rooms in the same Zone can't have the same name. * If allowed, the name can be changed through the ChangeRoomNameRequest request. */ readonly name: string; /** * Returns the Room Group name. * Each Group is identified by a unique string (its name or id) and it represents a different "container" for Rooms. * *

Room Groups enable developers to organize Rooms under different types or categories and let clients select only those Groups they are interested in, in order to receive their events only. * This is done via the SubscribeRoomGroupRequest and UnsubscribeRoomGroupRequest requests.

*/ readonly groupId: string; /** * Indicates whether this is a Game Room or not. */ readonly isGame: boolean; /** * Indicates whether this Room is hidden or not. * This is a utility flag that can be used by developers to hide certain Rooms from the interface of their application. */ readonly isHidden: boolean; /** * Indicates whether the client joined this Room or not. * Use the JoinRoomRequest request to join a new Room. */ readonly isJoined: boolean; /** * Indicates whether this Room requires a password to be joined or not. * This flag depends on the Room's password set when the Room is created or by means of the ChangeRoomPasswordStateRequest request. */ readonly isPasswordProtected: boolean; /** * Returns the maximum number of users allowed in this Room. * In case of Game Rooms, this is the maximum number of players. * If allowed, the maxUsers value can be changed through the ChangeRoomCapacityRequest request. */ readonly maxUsers: number; /** * Returns the maximum number of spectators allowed in this Room (Game Rooms only). * If allowed, the maxSpectators value can be changed through the ChangeRoomCapacityRequest request. */ readonly maxSpectators: number; /** * Returns the current number of users in this Room. * In case of Game Rooms, this is the number of players. */ readonly userCount: number; /** * Returns the current number of spectators in this Room (Game Rooms only). */ readonly spectatorCount: number; /** * Returns the maximum amount of users, including spectators, that can be contained in this Room. */ readonly capacity: number; /** * Returns a string that contains the Room id, name and id of the Group to which it belongs. * @returns The string representation of the SFSRoom object. */ toString(): string; /** * Retrieves a SFSUser object from its name property. * @param name - The name of the user to be found. * @returns An object representing the user, or undefined if no user with the passed name exists in this Room. */ getUserByName(name: string): SFSUser; /** * Retrieves a SFSUser object from its id property. * @param id - The id of the user to be found. * @returns An object representing the user, or undefined if no user with the passed id exists in this Room. */ getUserById(id: number): SFSUser; /** * Indicates whether the specified user is currently inside this Room or not. * @param user - The SFSUser object representing the user whose presence in this Room must be checked. * @returns true if the user is inside this Room; false otherwise. */ containsUser(user: SFSUser): boolean; /** * Retrieves the list of SFSUser objects representing all the users currently inside this Room. * @returns The list of SFSUser objects representing the users who joined the Room. */ getUserList(): SFSUser[]; /** * Retrieves the list of SFSUser objects representing the players currently inside this Room (Game Rooms only). * @returns The list of SFSUser objects representing the users who joined the Room as players. */ getPlayerList(): SFSUser[]; /** * Retrieves the list of SFSUser objects representing the spectators currently inside this Room (Game Rooms only). * @returns The list of SFSUser objects representing the users who joined the Room as spectators. */ getSpectatorList(): SFSUser[]; /** * Retrieves a Room Variable from its name. * @param varName - The name of the Room Variable to be retrieved. * @returns The object representing the Room Variable, or undefined if no Room Variable with the passed name exists in this Room. */ getVariable(varName: string): SFSRoomVariable; /** * Indicates whether this Room has the specified Room Variable set or not. * @param varName - The name of the Room Variable whose existance in this Room must be checked. * @returns true if a Room Variable with the passed name exists in this Room. */ containsVariable(varName: string): boolean; /** * Retrieves all the Room Variables of this Room. * @returns The list of SFSRoomVariable objects associated with this Room. */ getVariables(): SFSRoomVariable[]; /** * Retrieves a reference to the Room Manager which manages this Room. * @returns The Room Manager to which this Room is associated. */ getRoomManager(): SFSRoomManager; } /** * Developers never istantiate the MMORoom class: this is done internally by the SmartFoxServer 2X API. * *

The MMORoom is ideal for huge virtual worlds and MMO games because it works with proximity lists instead of "regular" users lists. * This allows thousands of users to interact with each other based on their Area of Interest (AoI). The AoI represents a range around the user * that is affected by server and user events, outside which no other events are received.

* *

The size of the AoI is set at Room creation time and it is the same for all users who joined it. * Supposing that the MMORoom hosts a 3D virtual world, setting an AoI of (x=100, y=100, z=40) for the Room tells the server to transmit updates and broadcast * events to and from those users that fall within the AoI range around the current user; this means the area within +/- 100 units on the X axis, +/- 100 units on the Y axis * and +/- 40 units on the Z axis.

* *

As the user moves around in the virtual environment, he can update his position in the corresponding MMORoom and thus continuously receive events * about other users (and items - see below) entering and leaving his AoI. * The player will be able to update his position via the SetUserPositionRequest request and receive updates on his current proximity list by means of the * proximityListUpdate event.

* *

Finally, MMORooms can also host any number of "MMOItems" which represent dynamic non-player objects that users can interact with. * They are handled by the MMORoom using the same rules of visibility described before.

*/ export class MMORoom { /** * Returns the default Area of Interest (AoI) of this MMORoom. */ readonly defaultAOI: Vec3D; /** * Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes. * If null is returned, no limits were set at Room creation time. */ readonly lowerMapLimit: Vec3D; /** * Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes. * If null is returned, no limits were set at Room creation time. */ readonly higherMapLimit: Vec3D; /** * Retrieves an MMOItem object from its id property. * * The item is available to the current user if it falls within his Area of Interest only. * @param id - The id of the item to be retrieved. * @returns An MMOItem object, or undefined if the item with the passed id is not in proximity of the current user. */ getMMOItem(id: number): MMOItem; /** * Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest. * @returns A list of MMOItem objects, or an empty list if no item is in proximity of the current user. */ getMMOItems(): MMOItem[]; } /** * Developers never istantiate the SFSUser class: this is done internally by the SmartFoxServer 2X API. * *

The SFSUser object represents a client logged in SmartFoxServer 2X. * The client API is not aware of all the clients (users) connected to the server, * but only of those that are in the same Rooms joined by the current client; this reduces the traffic between the client and the server considerably. * In order to interact with other users the client should join other Rooms or use the Buddy List system to keep track of and interact with friends.

*/ export class SFSUser { /** * Defines a generic utility object that can be used to store custom user data. * The values added to this object are for client-side use only and are never transmitted to the server or to the other clients. */ properties: any; /** * Indicates the id of this user. * The id is unique and it is generated by the server when the user logs in. */ readonly id: number; /** * Indicates the name of this user. * Two users in the same Zone can't have the same name. */ readonly name: string; /** * Indicates if this SFSUser object represents the current client. */ readonly isItMe: boolean; /** * Returns the id which identifies the privilege level of this user. * Privileges are assigned to the user by the server when the user logs in. */ readonly privilegeId: number; /** * Returns the entry point of this user in the current user's AoI. * *

The returned coordinates are those that the user had when his presence in the current user's Area of Interest was last notified by a proximityListUpdate event. * This field is populated only if the user joined a Room of type MMORoom and this is configured to receive such data from the server.

*/ readonly aoiEntryPoint: Vec3D; /** * Indicates whether this user logged in as a guest or not. * Guest users have the privilegeId property set to UserPrivileges.GUEST. */ readonly isGuest: boolean; /** * Indicates whether this user logged in as a standard user or not. * Standard users have the privilegeId property set to UserPrivileges.STANDARD. */ readonly isStandardUser: boolean; /** * Indicates whether this user logged in as a moderator or not. * Moderator users have the privilegeId property set to UserPrivileges.MODERATOR. */ readonly isModerator: boolean; /** * Indicates whether this user logged in as an administrator or not. * Administrator users have the privilegeId property set to UserPrivileges.ADMINISTRATOR. */ readonly isAdmin: boolean; /** * Indicates whether this user is a player (playerId greater than 0) in the last joined Room or not. * Non-Game Rooms always return false. * *

If the user is inside multiple Game Rooms at the same time, use the isPlayerInRoom() method.

*/ readonly isPlayer: boolean; /** * Indicates whether this user is a spectator (playerId lower than 0) in the last joined Room or not. * Non-Game Rooms always return false. * *

If the user is inside multiple Game Rooms at the same time, use the isSpectatorInRoom() method.

*/ readonly isSpectator: boolean; /** * Returns a string that contains the user id, name and a boolean indicating if the SFSUser object represents the current client. * @returns The string representation of the SFSUser object. */ toString(): string; /** * Indicates whether this user joined the passed Room or not. * @param room - The SFSRoom object representing the Room where to check the user presence. * @returns true if this user is inside the passed Room. */ isJoinedInRoom(room: SFSRoom): boolean; /** * Returns the playerId value of this user in the passed Room. * See the playerId property description for more informations. * @param room - The SFSRoom object representing the Room to retrieve the player id from. * @returns The playerId of this user in the passed Room. */ getPlayerId(room: SFSRoom): number; /** * Indicates whether this user is a player (playerId greater than 0) in the passed Room or not. * Non-Game Rooms always return false. * *

If a user can join one Game Rooms at a time only, use the isPlayer property.

* @param room - The SFSRoom object representing the Room where to check if this user is a player. * @returns true if this user is a player in the passed Room. */ isPlayerInRoom(room: SFSRoom): boolean; /** * Indicates whether this user is a spectator (playerId lower than 0) in the passed Room or not. * Non-Game Rooms always return false. * *

If a user can join one Game Rooms at a time only, use the isSpectator property.

* @param room - The SFSRoom object representing the Room where to check if this user is a spectator. * @returns true if this user is a spectator in the passed Room. */ isSpectatorInRoom(room: SFSRoom): boolean; /** * Retrieves a User Variable from its name. * @param varName - The name of the User Variable to be retrieved. * @returns The object representing the User Variable, or undefined if no User Variable with the passed name is associated with this user. */ getVariable(varName: string): SFSUserVariable; /** * Indicates whether this user has the specified User Variable set or not. * @param varName - The name of the User Variable whose existance must be checked. * @returns true if a User Variable with the passed name is set for this user. */ containsVariable(varName: string): boolean; /** * Retrieves all the User Variables of this user. * @returns The list of SFSUserVariable objects associated with the user. */ getVariables(): SFSUserVariable[]; /** * Returns a reference to the User Manager which manages this user. * @returns The User Manager to which this user is associated. */ getUserManager(): SFSUserManager; } /** * Developers never istantiate the UserPrivileges class: only use its static properties. * *

Values contained in this class (or custom-defined ones) are assigned to the SFSUser.privilegeId property whenever a user logs in.
* Read the SmartFoxServer 2X documentation for more informations about privilege profiles and their permissions.

*/ export class UserPrivileges { constructor(); /** * The Guest user is usually the lowest level in the privilege profiles scale. */ static readonly GUEST: number; /** * The standard user is usually registered in the application custom login system; uses a unique name and password to login. */ static readonly STANDARD: number; /** * The moderator user can send dedicated "moderator messages", kick and ban users. */ static readonly MODERATOR: number; /** * The administrator user can send dedicated "administrator messages", kick and ban users. */ static readonly ADMINISTRATOR: number; } /** * Developers never istantiate the ReservedBuddyVariables class: only use its static properties. */ export class ReservedBuddyVariables { constructor(); /** * The Buddy Variable with this name keeps track of the online/offline state of the user in a buddy list. *

This variable is persistent, which means that the online/offline state is preserved upon disconnection.

*/ static readonly BV_ONLINE: string; /** * The Buddy Variable with this name stores the custom state of the user in a buddy list. *

This variable is persistent, which means that the custom state is preserved upon disconnection.

*/ static readonly BV_STATE: string; /** * The Buddy Variable with this name stores the optional nickname of the user in a buddy list. *

This variable is persistent, which means that the nickname is preserved upon disconnection.

*/ static readonly BV_NICKNAME: string; } /** * Creates a new SFSBuddyVariable instance. * *

A SFSBuddyVariable is a custom value attached to a SFSBuddy object in a Buddy List that gets automatically synchronized between client and server on every change.

* *

Buddy Variables work with the same principle of the User and Room Variables. The only difference is the logic by which they get propagated to other users. * While Room and User Variables are usually broadcast to all clients in the same Room, Buddy Variables updates are sent to all users who have the owner of the Buddy Variable in their Buddy Lists.

* *

Buddy Variables are particularly useful to store custom user data that must be "visible" to the buddies only, such as a profile, a ranking, a status message, etc. * Buddy Variables can be set by means of the SetBuddyVariablesRequest request; they support the following data types (also nested): * boolean, number, string, SFSObject, SFSArray. A Buddy Variable can also be null.

* *

There is also a special convention that allows Buddy Variables to be set as "offline". * Offline Buddy Variables are persistent values which are made available to all users who have the owner in their Buddy List, whether that buddy is online or not. * In order to make a Buddy Variable persistent, its name should start with a dollar sign ($). * This conventional character is contained in the OFFLINE_PREFIX constant.

* @param name - The name of the Buddy Variable. * @param value - The value of the Buddy Variable; it can also be null. * @param [type = -1] - The type id of the Buddy Variable among those available in the VariableType class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value. */ export class SFSBuddyVariable extends BaseVariable { constructor(name: string, value: boolean | number | string | SFSObject | SFSArray, type?: number); /** * The prefix to be added to a Buddy Variable name to make it persistent. * A persistent Buddy Variable is made available to all users who have the owner in their Buddy List, whether that Buddy is online or not. */ static readonly OFFLINE_PREFIX: string; /** * Indicates whether the Buddy Variable is persistent or not. * *

By convention any Buddy Variable whose name starts with the dollar sign ($) will be regarded as persistent and stored locally by the server. * Persistent Buddy Variables are also referred to as "offline variables" because they are available to all users * who have the owner in their Buddy List, whether that Buddy is online or not.

*/ readonly isOffline: boolean; /** * Returns a string that contains the Buddy Variable name, type and value. * @returns The string representation of the SFSBuddyVariable object. */ toString(): string; /** * Indicates the name of this variable. */ readonly name: string; /** * Returns the value of this variable. */ readonly value: any; /** * Indicates the type of this Variable. * Possibly returned strings are: null, boolean, int, double, string, SFSObject, SFSArray. */ readonly type: string; /** * Indicates if the Variable is null. */ readonly isNull: boolean; } /** * Developers never istantiate the MMOItemVariable class: even if MMOItem Variables behave exactly like User Variables and support the same data types, they can be created, updated and deleted on the server side only. * *

An MMOItemVariable is a custom value attached to an MMOItem object that gets automatically synchronized between client and server on every change, * provided that the MMOItem is inside the Area of Interest of the current user in a MMORoom.

* @param name - The name of the MMOItem Variable. * @param value - The value of the MMOItem Variable; it can also be null. * @param [type = -1] - The type id of the MMOItem Variable among those available in the VariableType class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value. */ export class MMOItemVariable extends BaseVariable { constructor(name: string, value: boolean | number | string | SFSObject | SFSArray, type?: number); /** * Returns a string that contains the MMOItem Variable name, type and value. * @returns The string representation of the MMOItemVariable object. */ toString(): string; /** * Indicates the name of this variable. */ readonly name: string; /** * Returns the value of this variable. */ readonly value: any; /** * Indicates the type of this Variable. * Possibly returned strings are: null, boolean, int, double, string, SFSObject, SFSArray. */ readonly type: string; /** * Indicates if the Variable is null. */ readonly isNull: boolean; } /** * Developers never istantiate the ReservedRoomVariables class: only use its static properties. */ export class ReservedRoomVariables { constructor(); /** * The Room Variable with this name keeps track of the state (started or stopped) of a game created with the CreateSFSGameRequest request. */ static readonly RV_GAME_STARTED: string; } /** * Creates a new SFSRoomVariable instance. * *

A SFSRoomVariable is a custom value attached to a SFSRoom object that gets automatically synchronized between client and server on every change.

* *

Room Variables are particularly useful to store custom Room data such as a game status and other Room-level informations. * They can be set by means of the SetRoomVariablesRequest request; they support the following data types (also nested): * boolean, number, string, SFSObject, SFSArray. A Room Variable can also be null.

* *

Room Variables also support a number of specific flags:

* * @param name - The name of the Room Variable. * @param value - The value of the Room Variable; it can also be null. * @param [type = -1] - The type id of the Room Variable among those available in the VariableType class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value. */ export class SFSRoomVariable extends BaseVariable { constructor(name: string, value: boolean | number | string | SFSObject | SFSArray, type?: number); /** * Indicates whether this Room Variable is private or not. * A private Room Variable is visible to all users in the same Room, but it can be modified only by its owner (the user that created it). * *

NOTE: setting the isPrivate property manually on an existing Room Variable returned by the API has no effect on the server and can disrupt the API functioning. * This flag can be set after the Room Variable object is created using the constructor only.

*/ isPrivate: boolean; /** * Indicates whether this Room Variable is persistent or not. * A persistent Room Variable continues to exist in the Room after the user who created it has left it and until he disconnects. * *

NOTE: setting the isPersistent property manually on an existing Room Variable returned by the API has no effect on the server and can disrupt the API functioning. * This flag can be set after the Room Variable object is created using the constructor only.

*/ isPersistent: boolean; /** * Returns a string that contains the Room Variable name, type, value and isPrivate flag. * @returns The string representation of the SFSRoomVariable object. */ toString(): string; /** * Indicates the name of this variable. */ readonly name: string; /** * Returns the value of this variable. */ readonly value: any; /** * Indicates the type of this Variable. * Possibly returned strings are: null, boolean, int, double, string, SFSObject, SFSArray. */ readonly type: string; /** * Indicates if the Variable is null. */ readonly isNull: boolean; } /** * Creates a new SFSUserVariable instance. * *

A SFSUserVariable is a custom value attached to a SFSUser object that gets automatically synchronized between client and server on every change.

* *

User Variables are particularly useful to store custom user data that must be "visible" to the other users, such as a profile, a score, a status message, etc. * User Variables can be set by means of the SetUserVariablesRequest request; they support the following data types (also nested): * boolean, number, string, SFSObject, SFSArray. A User Variable can also be null.

* @param name - The name of the User Variable. * @param value - The value of the User Variable; it can also be null. * @param [type = -1] - The type id of the User Variable among those available in the VariableType class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value. */ export class SFSUserVariable extends BaseVariable { constructor(name: string, value: boolean | number | string | SFSObject | SFSArray, type?: number); /** * Indicates whether this User Variable is private or not. * A private User Variable is visible only to its owner; any changes made to the variable will be transmitted to the owner only. * *

NOTE: setting the isPrivate property manually on an existing User Variable returned by the API has no effect on the server and can disrupt the API functioning. * This flag can be set after the User Variable object is created using the constructor only.

*/ isPrivate: boolean; /** * Returns a string that contains the User Variable name, type, value and isPrivate flag. * @returns The string representation of the SFSUserVariable object. */ toString(): string; /** * Indicates the name of this variable. */ readonly name: string; /** * Returns the value of this variable. */ readonly value: any; /** * Indicates the type of this Variable. * Possibly returned strings are: null, boolean, int, double, string, SFSObject, SFSArray. */ readonly type: string; /** * Indicates if the Variable is null. */ readonly isNull: boolean; } /** * The valid types for User, Room, Buddy and MMOItem Variables to be passed to the respective constructors. */ export class VariableType { constructor(); /** * The Variable is null. */ static readonly NULL: number; /** * The type of the Variable is boolean. */ static readonly BOOLEAN: number; /** * The type of the Variable is number (specifically an integer). */ static readonly INT: number; /** * The type of the Variable is number (specifically a double). */ static readonly DOUBLE: number; /** * The type of the Variable is string. */ static readonly STRING: number; /** * The type of the Variable is SFSObject. */ static readonly SFSOBJECT: number; /** * The type of the Variable is SFSArray. */ static readonly SFSARRAY: number; } /** * Developers never istantiate the BaseVariable class: always use its child classes. */ export class BaseVariable { /** * Indicates the name of this variable. */ readonly name: string; /** * Returns the value of this variable. */ readonly value: any; /** * Indicates the type of this Variable. * Possibly returned strings are: null, boolean, int, double, string, SFSObject, SFSArray. */ readonly type: string; /** * Indicates if the Variable is null. */ readonly isNull: boolean; } /** * Developers never istantiate the SFSBuddyManager class: this is done internally by the SmartFoxServer 2X API; get a reference to it using the SmartFox.buddyManager property. * *

This class keeps track of all the user's buddies, their state and their Buddy Variables. * It also provides utility methods to set the user's properties when he is part of the buddies list of other users.

* *

IMPORTANT: no Buddy List related operations are allowed until the system is initialized using the InitBuddyListRequest request.

*/ export class SFSBuddyManager { /** * Indicates whether the client's Buddy List system is initialized or not. * If not, an InitBuddyListRequest request should be sent to the server in order to retrieve the persistent Buddy List data. */ readonly isInited: boolean; /** * Indicates whether a buddy exists in user's buddy list or not. * @param name - The name of the buddy whose presence in the buddy list is to be checked. * @returns true if the specified buddy exists in the buddy list. */ containsBuddy(name: string): boolean; /** * Retrieves a SFSBuddy object from its id property. * @param id - The id of the buddy to be retrieved. * @returns The SFSBuddy object representing the buddy, or undefined if no buddy with the passed id exists in the buddy list. */ getBuddyById(id: number): SFSBuddy; /** * Retrieves a SFSBuddy object from its name property. * @param name - The name of the buddy to be retrieved. * @returns The SFSBuddy object representing the buddy, or undefined if no buddy with the passed name exists in the buddy list. */ getBuddyByName(name: string): SFSBuddy; /** * Retrieves a SFSBuddy object using its nickName property. * @param nickName - The nickname of the buddy to be found. * @returns The SFSBuddy object representing the buddy, or undefined if no buddy with the passed nickname exists in the buddies list. */ getBuddyByNickName(nickName: string): SFSBuddy; /** * Returns a list of SFSBuddy objects representing all the offline buddies in the user's buddy list. * @returns A list of SFSBuddy objects representing the offline buddies. */ getOfflineBuddies(): SFSBuddy[]; /** * Returns a list of SFSBuddy objects representing all the online buddies in the user's buddy list. * @returns A list of SFSBuddy objects representing the online buddies. */ getOnlineBuddies(): SFSBuddy[]; /** * Returns a list of SFSBuddy objects representing all the buddies in the user's buddy list. * @returns A list of SFSBuddy objects representing all the buddies. */ getBuddyList(): SFSBuddy[]; /** * Retrieves a Buddy Variable set for the current user from its name. * @param varName - The name of the Buddy Variable to be retrieved. * @returns The SFSBuddyVariable object representing the Buddy Variable, or undefined if no Buddy Variable with the passed name is associated to the current user. */ getMyVariable(varName: string): SFSBuddyVariable; /** * Returns all the Buddy Variables set for the current user. * @returns A list of SFSBuddyVariable objects representing all the Buddy Variables set for the user. */ getMyVariables(): SFSBuddyVariable[]; /** * Returns the current user's online/offline state. * *

If true, the user appears to be online in the buddy list of other users who have him as a buddy.
* The online state of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class); * it can be changed using the dedicated GoOnlineRequest request.

* @returns true if the user is online in the Buddy List system. */ getMyOnlineState(): boolean; /** * Returns the current user's nickname (if set). * * If the nickname was never set before, null is returned. *

As the nickname of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class), * it can be set using the SetBuddyVariablesRequest request.

* @returns The user nickname in the Buddy List system. */ getMyNickName(): string; /** * Returns the current user's custom state (if set). * * Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state was never set before, null is returned. *

As the custom state of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class), * it can be set using the SetBuddyVariablesRequest request.

* @returns The user state in the Buddy List system. */ getMyState(): string; /** * Returns a list of strings representing the available custom buddy states. * *

The custom states are received by the client upon initialization of the Buddy List system. They can be configured by means of the SmartFoxServer 2X Administration Tool.

* @returns The list of available custom buddy states in the Buddy List system. */ getBuddyStates(): string[]; } /** * Developers never istantiate the SFSRoomManager class: this is done internally by the SmartFoxServer 2X API; get a reference to it using the SmartFox.roomManager property. * *

This class keeps track of all the Rooms available in the client-side Rooms list and of subscriptions to multiple Room Groups. * It also provides various utility methods to look for Rooms by name and id, retrieve Rooms belonging to a specific Group, etc.

*/ export class SFSRoomManager { /** * Returns the names of Groups currently subscribed by the client. * *

NOTE: at login time, the client automatically subscribes all the Room Groups specified in the Zone's Default Room Groups setting.

* @returns A list of Group names. */ getRoomGroups(): string[]; /** * Indicates whether the specified Group has been subscribed by the client or not. * @param groupId - The name of the Group. * @returns true if the client subscribed the passed Group. */ containsGroup(groupId: string): boolean; /** * Indicates whether a Room exists in the Rooms list or not. * @param idOrName - The id or name of the SFSRoom object whose presence in the Rooms list is to be tested. * @returns true if the passed Room exists in the Rooms list. */ containsRoom(idOrName: number | string): boolean; /** * Indicates whether the Rooms list contains a Room belonging to the specified Group or not. * @param idOrName - The id or name of the SFSRoom object whose presence in the Rooms list is to be tested. * @param groupId - The name of the Group to which the specified Room must belong. * @returns true if the Rooms list contains the passed Room and it belongs to the specified Group. */ containsRoomInGroup(idOrName: number | string, groupId: string): boolean; /** * Retrieves a SFSRoom object from its id property. * @example * This example retrieves a SFSRoom object and traces its name. * var roomId = 3; * var room = sfs.getRoomById(roomId); * console.log("The name of Room " + roomId + " is " + room.name); * @param id - The id of the Room to be retrieved. * @returns The object representing the requested Room; undefined if no SFSRoom object with the passed id exists in the Rooms list. */ getRoomById(id: number): SFSRoom; /** * Retrieves a SFSRoom object from its name property. * @example * This example retrieves a SFSRoom object and traces its id. * var roomName = "The Lobby"; * var room = sfs.getRoomByName(roomName); * console.log("The ID of Room '" + roomName + "' is " + room.id); * @param name - The name of the Room to be retrieved. * @returns The object representing the requested Room; undefined if no SFSRoom object with the passed name exists in the Rooms list. */ getRoomByName(name: string): SFSRoom; /** * Returns a list of Rooms currently "known" by the client. * *

The list contains all the Rooms that are currently joined and all the Rooms belonging to the Room Groups that have been subscribed.

* *

NOTE: at login time, the client automatically subscribes all the Room Groups specified in the Zone's Default Room Groups setting.

* @returns The list of the available SFSRoom objects. */ getRoomList(): SFSRoom[]; /** * Returns the current number of Rooms in the Rooms list. * @returns The number of Rooms in the Rooms list. */ getRoomCount(): number; /** * Retrieves the list of Rooms which are part of the specified Room Group. * @param groupId - The name of the Group. * @returns The list of SFSRoom objects belonging to the passed Group. */ getRoomListFromGroup(groupId: string): SFSRoom[]; /** * Returns a list of Rooms currently joined by the client. * @returns The list of SFSRoom objects representing the Rooms currently joined by the client. */ getJoinedRooms(): SFSRoom[]; /** * Retrieves a list of Rooms joined by the specified user. * *

The list contains only those Rooms "known" by the Room Manager; the user might have joined others the client is not aware of.

* @param user - A SFSUser object representing the user to look for in the current Rooms list. * @returns The list of Rooms joined by the passed user. */ getUserRooms(user: SFSUser): SFSRoom[]; } /** * Developers never istantiate the SFSUserManager class: this is done internally by the SmartFoxServer 2X API; get a reference to it using the SmartFox.userManager property. * *

This class keeps track of all the users that are currently joined in the same Rooms of the current user. * It also provides utility methods to look for users by name and id.

*/ export class SFSUserManager { /** * Indicates whether a user exists in the local users list or not from the name. * @param userName - The name of the user whose presence in the users list is to be tested. * @returns true if the passed user exists in the users list. */ containsUserName(userName: string): boolean; /** * Indicates whether a user exists in the local users list or not from the id. * @param userId - The id of the user whose presence in the users list is to be tested. * @returns true if the passed user exists in the users list. */ containsUserId(userId: number): boolean; /** * Indicates whether a user exists in the local users list or not. * @param user - The SFSUser object representing the user whose presence in the users list is to be tested. * @returns true if the passed user exists in the users list. */ containsUser(user: SFSUser): boolean; /** * Retrieves a SFSUser object from its id property. * @param userId - The id of the user to be retrieved. * @returns The SFSUser object representing the user, or undefined if no user with the passed id exists in the local users list. */ getUserById(userId: number): SFSUser; /** * Retrieves a SFSUser object from its name property. * @param userName - The name of the user to be retrieved. * @returns The SFSUser object representing the user, or undefined if no user with the passed name exists in the local users list. */ getUserByName(userName: string): SFSUser; /** * Returns the total number of users in the local users list. * @returns The number of users in the local users list. */ getUserCount(): number; /** * Get the whole list of users inside the Rooms joined by the client. * @returns The list of SFSUser objects representing the users in the local users list. */ getUserList(): SFSUser[]; } /** * Developers never istantiate the BaseRequest class; see the ...Request classes. */ export class BaseRequest { } /** * Creates a new RoomSettings instance. * *

The instance must be passed to the CreateRoomRequest class constructor.

* @param name - The name of the Room to be created. */ export class RoomSettings { constructor(name: string); /** * Defines the name of the Room. */ name: string; /** * Sets the password of the Room. * *

If the password is set to an empty string, the Room won't be password protected.

*/ password: string; /** * Sets the id of the Group to which the Room should belong. * *

If the Group doesn't exist yet, a new one is created before assigning the Room to it.

*/ groupId: string; /** * Sets whether the Room is a Game Room or not. */ isGame: boolean; /** * Sets the maximum number of users allowed in the Room. *

In case of Game Rooms, this is the maximum number of players.

*/ maxUsers: number; /** * Sets the maximum number of spectators allowed in the Room (only for Game Rooms). */ maxSpectators: number; /** * Sets the maximum number of Room Variables allowed for the Room. */ maxVariables: number; /** * Sets a list of SFSRooomVariable objects to be attached to the Room. */ variables: SFSRoomVariable[]; /** * Sets the flags indicating which operations are permitted on the Room. * *

Permissions include: name and password change, maximum users change and public messaging. * If set to null, the permissions configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).

*/ permissions: RoomPermissions; /** * Sets the flags indicating which events related to the Room are dispatched by the SmartFox client. * *

Room events include: users entering or leaving the room, user count change and user variables update. * If set to null, the events configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).

*/ events: RoomEvents; /** * Sets the Extension that must be attached to the Room on the server-side, and its settings. */ extension: RoomExtension; /** * Specifies if the Room allows "Join Room" invitations to be sent by any user or just by its owner. */ allowOwnerOnlyInvitation: boolean; } /** * Creates a new SFSGameSettings instance. * *

The instance must be passed to the CreateSFSGameRequest class constructor.

* *

On the server-side, a Game Room is represented by the SFSGame Java class which extends the Room class * providing new advanced features such as player matching, game invitations, public and private games, quick game joining, etc. * On the client side Game Rooms are regular Rooms with their isGame property set to true.

* @param name - The name of the Game Room to be created. */ export class SFSGameSettings { constructor(name: string); /** * Indicates whether the game is public or private. * *

A public game can be joined by any player whose User Variables match the playerMatchExpression assigned to the Game Room. * A private game can be joined by users invited by the game creator by means of invitedPlayers list.

*/ isPublic: boolean; /** * Defines the minimum number of players required to start the game. * *

If the notifyGameStarted property is set to true, when this number is reached, the game start is notified.

*/ minPlayersToStartGame: number; /** * In private games, defines a list of SFSUser objects representing players to be invited to join the game. * *

If the invitations are less than the minimum number of players required to start the game (see the minPlayersToStartGame property), * the server will send additional invitations automatically, searching users in the Room Groups specified in the searchableRooms list * and filtering them by means of the object passed to the playerMatchExpression property.

* *

The game matching criteria contained in the playerMatchExpression property do not apply to the users specified in this list.

*/ invitedPlayers: SFSUser[]; /** * In private games, defines a list of Groups names where to search players to invite. * *

If the users invited to join the game (specified through the invitedPlayers property) are less than the minimum number of * players required to start the game (see the minPlayersToStartGame property), * the server will invite others automatically, searching them in Rooms belonging to the Groups specified in this list * and filtering them by means of the object passed to the playerMatchExpression property.

*/ searchableRooms: string[]; /** * In private games, defines the number of seconds that users have to reply to the invitation to join a game. * *

The suggested range is 10 to 40 seconds.

*/ invitationExpiryTime: number; /** * In private games, indicates whether the players must leave the previous Room when joining the game or not. * *

This setting applies to private games only because users join the Game Room automatically when they accept the invitation to play, * while public games require a JoinRoomRequest request to be sent, where this behavior can be determined manually.

*/ leaveLastJoinedRoom: boolean; /** * Indicates if a game state change must be notified when the minimum number of players is reached. * *

If this setting is true, the game state (started or stopped) is handled by means of the reserved Room Variable * represented by the ReservedRoomVariables.RV_GAME_STARTED constant. Listening to the roomVariablesUpdate event for this variable * allows clients to be notified when the game can start due to minimum number of players being reached.

* *

As the used Room Variable is created as global (see the SFSRoomVariable class description), its update is broadcast outside the Room too: * this can be used on the client-side, for example, to show the game state in a list of available games.

*/ notifyGameStarted: boolean; /** * Defines the game matching expression to be used to filters players. * *

Filtering is applied when:

* * *

Filtering is not applied to users invited by the creator to join a private game (see the invitedPlayers property).

*/ playerMatchExpression: MatchExpression; /** * Defines the game matching expression to be used to filters spectators. * *

Filtering is applied when users try to join a public Game Room as spectators (their User Variables must match the matching criteria).

*/ spectatorMatchExpression: MatchExpression; /** * In private games, defines an optional SFSObject containing additional custom parameters to be sent together with the invitation. * *

Possible custom parameters to be transferred to the invitees are a message for the recipient, the game details (title, type...), the inviter details, etc.

*/ invitationParams: SFSObject; } /** * Creates a new MMORoomSettings instance. * *

The instance must be passed to the CreateRoomRequest class constructor.

* @param name - The name of the MMORoom to be created. * @param defaultAOI - The Area of Interest (AoI) for the MMORoom to be created. */ export class MMORoomSettings { constructor(name: string, defaultAOI: Vec3D); /** * Defines the Area of Interest (AoI) for the MMORoom. * *

This value represents the area/range around the user that will be affected by server events and other users events. * It is a Vec3D object providing 2D or 3D coordinates. For example a Vec3D(50,50) describes a range of 50 units (e.g. pixels) in all four directions (top, bottom, left, right) * with respect to the user position in a 2D coordinates system. A Vec3D(120,120,60) instead describes a range of 120 units in all four directions (top, bottom, left, right) * and 60 units along the two Z-axis directions (backward, forward) with respect to the user position in a 3D coordinates system.

*/ defaultAOI: Vec3D; /** * Defines the limits of the virtual environment represented by the MMORoom. * *

When specified, this property must contain two non-null Vec3D objects representing the minimum and maximum limits of the 2D/3D coordinates systems. * Any positional value that falls outside the provided limit will be refused by the server.

* *

This setting is optional but its usage is highly recommended.

*/ mapLimits: MapLimits; /** * Defines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room. * *

As soon as the MMORoom is joined, the user still doesn't have a physical position set in the coordinates system, therefore it is * considered in a "limbo" state. At this point the user is expected to set his position (via the SetUserPositionRequest request) within the * amount of seconds expressed by this value.

*/ userMaxLimboSeconds: number; /** * Configures the speed at which the SFSEvent.PROXIMITY_LIST_UPDATE event is sent by the server. * *

In an MMORoom, the regular users list is replaced by a proximity list, which keeps an updated view of the users currently within the Area of Interest * of the current user. The speed at which these updates are fired by the server is regulated by this parameter, which sets the minimum time between two subsequent updates.

* *

NOTE: values below the default might be unnecessary for most applications unless they are in realtime.

*/ proximityListUpdateMillis: number; /** * Sets if the users entry points in the current user's Area of Interest should be transmitted in the SFSEvent.PROXIMITY_LIST_UPDATE event. * *

If this setting is set to true, when a user enters the AoI of another user, the server will also send the coordinates * at which the former "appeared" within the AoI. This option should be turned off in case these coordinates are not needed, in order to save bandwidth.

*/ sendAOIEntryPoint: boolean; } /** * Creates a new ClusterRoomSettings instance. * *

The instance must be passed to the ClusterJoinOrCreateRequest class constructor.

* *

On the server-side, a Game Room is represented on the Game Node by the SFSGame Java class, which extends the Room class * providing advanced features such as player matching, game invitations, public and private games, quick game joining, etc. * On the client side Game Rooms are regular Rooms with their isGame property set to true.

* @param name - The name of the Game Room to be created. */ export class ClusterRoomSettings { constructor(name: string); /** * Indicates whether the game is public or private. * *

A public game can be joined by any player whose User Variables match the playerMatchExpression assigned to the Game Room. * A private game can be joined by users invited by the game creator by means of invitedPlayers list.

*/ isPublic: boolean; /** * Defines the minimum number of players required to start the game. * *

If the notifyGameStarted property is set to true, when this number is reached, the game start is notified.

*/ minPlayersToStartGame: number; /** * In private games, defines a list of SFSUser or SFSBuddy objects representing players to be invited to join the game. */ invitedPlayers: SFSUser[] | SFSBuddy[]; /** * In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation. * *

The suggested range is 30 to 60 seconds.

*/ invitationExpiryTime: number; /** * Indicates if a game state change must be notified when the minimum number of players is reached. * *

If this setting is true, the game state (started or stopped) is handled by means of the reserved Room Variable * represented by the ReservedRoomVariables.RV_GAME_STARTED constant. Listening to the roomVariablesUpdate event for this variable * allows clients to be notified when the game can start due to minimum number of players being reached.

*/ notifyGameStarted: boolean; /** * In private games, defines an optional SFSObject containing additional custom parameters to be sent together with the invitation. * *

Possible custom parameters to be transferred to the invitees are a message for the recipient, the game details (title, type...), the inviter details, etc.

*/ invitationParams: SFSObject; } /** * Creates a new RoomPermissions instance. * *

The RoomSettings.permissions property must be set to this instance during Room creation.

*/ export class RoomPermissions { /** * Sets whether changing the Room name after its creation is allowed or not. * *

The Room name can be changed by means of the ChangeRoomNameRequest request.

*/ allowNameChange: boolean; /** * Sets whether changing (or removing) the Room password after its creation is allowed or not. * *

The Room password can be changed by means of the ChangeRoomPasswordStateRequest request.

*/ allowPasswordStateChange: boolean; /** * Sets whether users inside the Room are allowed to send public messages or not. * *

Public messages can be sent by means of the PublicMessageRequest request.

*/ allowPublicMessages: boolean; /** * Sets whether the Room capacity can be changed after its creation or not. * *

The capacity is the maximum number of users and spectators (in Game Rooms) allowed to enter the Room. * It can be changed by means of the ChangeRoomCapacityRequest request.

*/ allowResizing: boolean; } /** * Creates a new RoomEvents instance. * *

The RoomSettings.events property must be set to this instance during Room creation.

*/ export class RoomEvents { /** * Sets whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room. */ allowUserCountChange: boolean; /** * Sets whether the userEnterRoom event should be dispatched whenever a user joins the Room or not. */ allowUserEnter: boolean; /** * Sets whether the userExitRoom event should be dispatched whenever a user leaves the Room or not. */ allowUserExit: boolean; /** * Sets whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables. */ allowUserVariablesUpdate: boolean; } /** * Creates a new RoomExtension instance. * *

The RoomSettings.extension property must be set to this instance during Room creation.

* @param id - The name of the Extension as deployed on the server; it's the name of the folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder. * @param className - The fully qualified name of the main class of the Extension. */ export class RoomExtension { constructor(id: string, className: string); /** * Returns the name of the Extension to be attached to the Room. * *

It's the name of the server-side folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder.

*/ id: string; /** * Returns the fully qualified name of the main class of the Extension. */ className: string; /** * Sets the name of an optional properties file that should be loaded on the server-side during the Extension initialization. * *

The file must be located in the server-side folder containing the Extension classes (see the id property).

*/ propertiesFile: string; } /** * Creates a new MapLimits instance. * *

The MMORoomSettings.mapLimits property must be set to this instance during MMORoom creation.

* @param lowerLimit - The lower coordinates limit of the virtual environment along the X,Y,Z axes. * @param higherLimit - The higher coordinates limit of the virtual environment along the X,Y,Z axes. */ export class MapLimits { constructor(lowerLimit: Vec3D, higherLimit: Vec3D); /** * Returns the lower coordinates limit of the virtual environment along the X,Y,Z axes. */ lowerLimit: Vec3D; /** * Returns the higher coordinates limit of the virtual environment along the X,Y,Z axes. */ higherLimit: Vec3D; } /** * Developers never istantiate the BanMode class: only use its static properties. */ export class BanMode { constructor(); /** * User is banned by IP address. */ static readonly BY_ADDRESS: number; /** * User is banned by name. */ static readonly BY_NAME: number; } /** * Creates a new MessageRecipientMode instance. * *

The instance must be passed as recipientMode parameter to the ModeratorMessageRequest and AdminMessageRequest classes constructors.

* @param mode - One of the costants contained in this class, describing the recipient mode. * @param target - The moderator/administrator message recipient/s, according to the selected recipient mode. */ export class MessageRecipientMode { constructor(mode: number, target: SFSUser | SFSRoom | string); /** * The moderator/administrator message will be sent to a specific user. *

A SFSUser instance must be passed as target parameter to the class constructor.

*/ static readonly TO_USER: number; /** * The moderator/administrator message will be sent to all the users in a specific Room. *

A SFSRoom instance must be passed as target parameter to the class constructor.

*/ static readonly TO_ROOM: number; /** * The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group. *

A Group id must be passed as target parameter to the class constructor.

*/ static readonly TO_GROUP: number; /** * The moderator/administrator message will be sent to all the users in the Zone. *

null can be passed as target parameter, in fact it will be ignored.

*/ static readonly TO_ZONE: number; /** * Returns the selected recipient mode. */ readonly mode: number; /** * Returns the moderator/administrator message target, according to the selected recipient mode. */ readonly target: SFSUser | SFSRoom | string; } /** * Creates a new ClusterTarget instance. * *

The instance must be passed as target parameter to the ClusterInviteUsersRequest class constructor.

* @param nodeId - The identifier of the Game Node where the Room is located. * @param roomId - The identifier of the Room on the Game Node. */ export class ClusterTarget { constructor(nodeId: string, roomId: number); /** * Indicates the identifier of the Game Node where the Room is located. */ readonly nodeId: string; /** * Indicates the identifier of the Room on the Game Node. */ readonly roomId: number; } /** * Creates a new AddBuddyRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

In order to add a buddy, the current user must be online in the Buddy List system. If the buddy is added successfully, the operation is confirmed by a buddyAdd event; * otherwise the buddyError event is fired.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

* @example * This example sends a request to add a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ADD, onBuddyAdded, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Add Jack as a new buddy to my buddies list * sfs.send(new SFS2X.AddBuddyRequest("Jack")); * } * * function onBuddyAdded(evtParams) * { * console.log("This buddy was added: " + evtParams.buddy.name); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } * @param buddyName - The name of the user to be added as a buddy. */ export class AddBuddyRequest { constructor(buddyName: string); } /** * Creates a new BlockBuddyRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Blocked buddies won't be able to see if the user who blocked them is online in their buddy list; they also won't be able to send messages or requests to that user.

* *

In order to block a buddy, the current user must be online in the Buddy List system. If the operation is successful, a buddyBlock confirmation event is dispatched; * otherwise the buddyError event is fired.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

* @example * This example handles the possible events caused by a request to block a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_BLOCK, onBuddyBlock, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Block user "Jack" in my buddies list * smartFox.send(new SFS2X.BlockBuddyRequest("Jack", true)); * } * * function onBuddyBlock(evtParams) * { * var isBlocked = evtParams.buddy.isBlocked; * console.log("Buddy " + evtParams.buddy.name + " is now " + (isBlocked ? "blocked" : "unblocked")); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } * @param buddyName - The name of the buddy to be removed from the user's buddy list. * @param blocked - true if the buddy must be blocked; false if he must be unblocked. */ export class BlockBuddyRequest { constructor(buddyName: string, blocked: boolean); } /** * Creates a new BuddyMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Messages sent to buddies using the BuddyMessageRequest request are similar to the standard private messages (see the PrivateMessageRequest request) * but are specifically designed for the Buddy List system: they don't require any Room parameter, nor they require that users joined a Room. * Additionally, buddy messages are subject to specific validation, such as making sure that the recipient is in the sender's buddies list and the sender is not blocked by the recipient.

* *

If the operation is successful, a buddyMessage event is dispatched in both the sender and recipient clients.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

* @example * This example sends a message to a buddy and handles the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_MESSAGE, onBuddyMessage, this); * * // Get the recipient of the message, in this case my buddy Jack * var buddy = sfs.buddyManager.getBuddyByName("Jack"); * * // Send a message to Jack * sfs.send(new SFS2X.BuddyMessageRequest("Hello Jack!", buddy)); * } * * function onBuddyMessage(evtParams) * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var isItMe = evtParams.isItMe; * var sender = evtParams.buddy; * * if (isItMe) * console.log("I said: " + evtParams.message); * else * console.log("My buddy " + sender.name + " said: " + evtParams.message); * } * @param message - The message to be sent to a buddy. * @param targetBuddy - The SFSBuddy object corresponding to the message recipient. * @param [params = null] - A SFSObject containing additional custom parameters (e.g. the message color, an emoticon id, etc). */ export class BuddyMessageRequest { constructor(message: string, targetBuddy: SFSBuddy, params?: SFSObject); } /** * Creates a new GoOnlineRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

All clients who have the current user as buddy in their buddy list will receive the buddyOnlineStateChange event and see the SFSBuddy.isOnline property return its value accordingly. * The same event is also dispatched to the current user, who sent the request, so that the application interface can be updated accordingly. * Going online/offline as buddy doesn't affect the user connection, the currently joined Zone and Rooms, etc.

* *

The online state of a user in a buddy list is handled by means of a reserved and persistent Buddy Variable.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

* @example * This example changes the user online state in the Buddy List system. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ONLINE_STATE_CHANGE, onBuddyOnlineStateChanged, this); * * // Put myself offline in the Buddy List system * sfs.send(new SFS2X.GoOnlineRequest(false)); * } * * function onBuddyOnlineStateChanged(evtParams) * { * // As the state change event is dispatched to me too, * // I have to check if I am the one who changed his state * * var isItMe = evtParams.isItMe; * * if (isItMe) * console.log("I'm now " + (sfs.buddyManager.getMyOnlineState() ? "online" : "offline")); * else * console.log("My buddy " + evtParams.buddy.name + " is now " + (evtParams.buddy.isOnline ? "online" : "offline")); * } * @param online - true to make the current user available (online) in the Buddy List system; false to make him not available (offline). */ export class GoOnlineRequest { constructor(online: boolean); } /** * Creates a new InitBuddyListRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Buddy List system initialization involves loading any previously stored buddy-specific data from the server, such as the current user's buddy list, his previous state and the persistent Buddy Variables. * The initialization request is the first operation to be executed in order to be able to use the Buddy List system features. * Once the initialization is completed, the buddyListInit event id fired and the user has access to all his data set previously and he can start to interact with his buddies; * if the initialization fails, a buddyError event is fired.

* @example * This example initializes the Buddy List system. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_LIST_INIT, onBuddyListInitialized, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this) * * // Initialize the Buddy List system * sfs.send(new SFS2X.InitBuddyListRequest()); * } * * function onBuddyListInitialized(evtParams) * { * console.log("Buddy List system initialized successfully"); * * // Retrieve my buddies list * var buddies = sfs.buddyManager.getBuddyList(); * * // Display the online buddies in a list component in the application interface * ... * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } */ export class InitBuddyListRequest { } /** * Creates a new RemoveBuddyRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

In order to remove a buddy, the current user must be online in the Buddy List system. If the buddy is removed successfully, the operation is confirmed by a buddyRemove event; * otherwise the buddyError event is fired.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

* @example * This example sends a request to remove a buddy. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_REMOVE, onBuddyRemoved, this); * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_ERROR, onBuddyError, this); * * // Remove Jack from my buddies list * sfs.send(new SFS2X.Requests.BuddyList.RemoveBuddyRequest("Jack")); * } * * function onBuddyRemoved(evtParams) * { * console.log("This buddy was removed: " + evtParams.buddy.name); * } * * function onBuddyError(evtParams) * { * console.log("The following error occurred while executing a buddy-related request: " + evtParams.errorMessage); * } * @param buddyName - The name of the buddy to be removed from the user's buddy list. */ export class RemoveBuddyRequest { constructor(buddyName: string); } /** * Creates a new SetBuddyVariablesRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This operation updates the SFSBuddy object representing the user in all the buddy lists in which the user was added as a buddy. * If the operation is successful, a buddyVariablesUpdate event is dispatched to all the owners of those buddy lists and to the user who updated his variables too.

* *

The Buddy Variables can be persisted, which means that their value will be saved even it the user disconnects and it will be restored when he connects again. * In order to make a variable persistent, put the constant SFSBuddyVariable.OFFLINE_PREFIX before its name. Read the SmartFoxServer 2X documentaion about the Buddy List API for more informations.

* *

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description) * and the current user state in the system is "online".

* @example * This example sets some Buddy Variables for the current user, one of which is persistent and another one is the reserved variable used to set the nickname; the example also handles changes made by the user or by his buddies. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE, onBuddyVarsUpdate, this); * * // Create two Buddy Variables containing the title and artist of the song I'm listening to * var songTitle = new SFS2X.SFSBuddyVariable("songTitle", "Ascension"); * var songAuthor = new SFS2X.SFSBuddyVariable("songAuthor", "Mike Oldfield"); * * // Create a persistent Buddy Variable containing my mood message * var mood = new SFS2X.SFSBuddyVariable(SFS2X.SFSBuddyVariable.OFFLINE_PREFIX + "mood", "SFS2X rocks!"); * * // Set my nickname * var nick = new SFS2X.SFSBuddyVariable(SFS2X.ReservedBuddyVariables.BV_NICKNAME, "Bax"); * * // Set my Buddy Variables * var vars = [songTitle, songAuthor, mood, nick]; * sfs.send(new SFS2X.SetBuddyVariablesRequest(vars)); * } * * function onBuddyVarsUpdate(evtParams) * { * // As the update event is dispatched to me too, * // I have to check if I am the one who changed his Buddy Variables * * var isItMe = evtParams.isItMe; * * if (isItMe) * { * console.log("I've updated the following Buddy Variables:"); * * for (var i = 0; i < evtParams.changedVars.length; i++) * { * var bVarName = evtParams.changedVars[i]; * console.log(bVarName + " -->; " + sfs.buddyManager.getMyVariable(bVarName).value); * } * } * else * { * var buddyName = evtParams.buddy.name; * * console.log("My buddy " + buddyName + " updated the following Buddy Variables:"); * * for (var i = 0; i < evtParams.changedVars.length; i++) * { * var bVarName = evtParams.changedVars[i]; * console.log(bVarName + " --> " + sfs.buddyManager.getBuddyByName(buddyName).getVariable(bVarName).value); * } * } * } * @param buddyVariables - A list of SFSBuddyVariable objects representing the Buddy Variables to set. */ export class SetBuddyVariablesRequest { constructor(buddyVariables: SFSBuddyVariable[]); } /** * Creates a new ClusterInviteUsersRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

In the SmartFoxServer 2X Cluster environment, this request sends a generic invitation to a list of users to join a Room on a Game Node. * Invitations can be used for different purposes, such as requesting users to join a game or visit a specific Room, asking the permission to add them as buddies, etc. * Invited users receive the invitation as an invitation event dispatched to their clients: they can accept or refuse it * by means of the InvitationReplyRequest request, which must be sent within the specified amount of time.

*

If the invitation is accepted, and the invited user is not yet connected to the target Game Node, the connectionRequired event * is dispatched to the their client, followed by a roomJoin event after the connection and login process is completed. * In case the client is already connected to the target Game Node, the roomJoin event is received immediately.

* @example * This example sends an invitation to join the current user in their current Game Room. * function someMethod() * { * // Set target Game Node and Room * var target = new SFS2X.ClusterTarget(sfsGame.nodeId, sfsGame.lastJoinedRoom.id); * * // Choose the invitation recipients * var friend1 = sfsLobby.buddyManager.getBuddyByName("Piggy"); * var friend2 = sfsLobby.buddyManager.getBuddyByName("Gonzo"); * * // Set the custom invitation details * var params = new SFS2X.SFSObject(); * params.putUtfString("msg", "Would you like to join me in my private room?"); * * // Send the invitation; recipients have 20 seconds to reply before the invitation expires * sfsLobby.send(new SFS2X.ClusterInviteUsersRequest(target, [friend1, friend2], 20, params)); * } * @param target - A ClusterTarget object containing the identifiers of the Game Node and Room the users are invited to join. * @param invitedUsers - A list of SFSUser objects, each representing a user to send the invitation to. * @param secondsForAnswer - The number of seconds available to each invited user to reply to the invitation (recommended range: 15 to 40 seconds). * @param [params = null] - An SFSObject containing custom parameters containing additional invitation details. */ export class ClusterInviteUsersRequest { constructor(target: ClusterTarget, invitedUsers: SFSUser[] | SFSBuddy[], secondsForAnswer: number, params?: SFSObject); } /** * Creates a new ClusterJoinOrCreateRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

The Lobby Node searches for a public Game Room that meets the criteria expressed by the passed matching expression in the passed Room Groups. * If no suitable Game Room can be found or a null matching expression is passed, and if the settings parameter is set, a new Game Room * is created on a Game Node selected by the cluster's load balancing system.

* *

In any case, if a game to join can be found or is created, the connectionRequired event is dispatched to the requester's client, * followed by a roomJoin event after the connection and login process is completed. * In case the client is already connected to the target Game Node, the roomJoin event is received immediately.

* @example * The following example makes the user quickly join a public game. * function someMethod() * { * sfsLobby.addEventListener(SFS2X.SFSClusterEvent.CONNECTION_REQUIRED, onGameNodeConnectionRequired, this); * * // Create a matching expression to find a Darts game with a "maxBet" variable less than 100 * var exp = new SFS2X.MatchExpression("type", SFS2X.StringMatch.EQUALS, "darts").and("maxBet", SFS2X.NumberMatch.LESS_THAN, 100); * * // Set the Room settings to create a new game Room if one is not found * var settings = new SFS2X.ClusterRoomSettings("NewRoom__" + Math.floor(Math.random() * 1000)); * settings.groupId = "games"; * settings.isPublic = true; * settings.isGame = true; * settings.maxUsers = 10; * settings.minPlayersToStartGame = 2; * * // Search (or create) and join a public game within the "games" Group * sfsLobby.send(new SFS2X.ClusterJoinOrCreateRequest(exp, ["games"], settings)); * } * * function onGameNodeConnectionRequired(evtParams) * { * // Retrieve connection settings * var cfg = evtParams.configData; * * // Retrieve and save login details * gameUsername = evtParams.userName; * gamePassword = evtParams.password; * * // Initialize SmartFox client used to connect to the cluster game node * sfsGame = new SmartFox(cfg); * * // Add event listeners * sfsGame.addEventListener(SFS2X.SFSEvent.CONNECTION, onGameNodeConnection, this); * sfsGame.addEventListener(SFS2X.SFSEvent.LOGIN, onGameNodeLogin, this); * sfsGame.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onGameRoomJoin, this); * * // Establish a connection to the game node; a game room will be joined automatically after login * sfsGame.connect(); * } * * function onGameNodeConnection(evtParams) * { * if (evtParams.success) * { * // Login * sfsGame.send(new SFS2X.LoginRequest(gameUsername, gamePassword)); * } * } * * function onGameNodeLogin(evtParams) * { * // Nothing to do; a game Room-autojoin is triggered by the server * } * * function onGameRoomJoin(evtParams) * { * console.log("Successfully joined Room: " + evtParams.room); * } * @param matchExpression - A matching expression that the system will use to search a Game Room where to join the current user; if null, a new Game Room will be created. * @param groupList - A list of group names to further filter the search; if null, all groups will be searched. * @param settings - If no Rooms are found through the matching expression, a new Room with the passed settings will be created and the user will auto-join it. */ export class ClusterJoinOrCreateRequest { constructor(matchExpression: MatchExpression, groupList: string[], settings: MMORoomSettings | ClusterRoomSettings); } /** * Creates a new CreateSFSGameRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request creates a new Game Room in the current Zone through the istantiation of a SFSGame object on the server-side, * a specialized Room type that provides advanced features during the creation phase of a game. * Specific game-configuration settings are passed by means of the SFSGameSettings class.

* *

If the creation is successful, a roomAdd event is dispatched to all the users who subscribed the Group to which the Room is associated, including the game creator. * Otherwise, a roomCreationError event is returned to the creator's client.
* Also, if the settings passed in the SFSGameSettings object cause invitations to join the game to be sent, an invitation event is * dispatched to all the recipient clients.

* *

Check the SmartFoxServer 2X documentation for a more in-depth overview of the GAME API.

* @example * This example creates a new Game Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_ADD, onRoomCreated, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CREATION_ERROR, onRoomCreationError, this); * * // Prepare the settings for a public game * var settings = new SFS2X.SFSGameSettings("DartsGame"); * settings.maxUsers = 2; * settings.maxSpectators = 8; * settings.isPublic = true; * settings.minPlayersToStartGame = 2; * settings.notifyGameStarted = true; * * // Set the matching expression to filter users who can join the Room * settings.playerMatchExpression = new SFS2X.MatchExpression("bestScore", SFS2X.NumberMatch.GREATER_THAN, 100); * * // Set a Room Variable containing the description of the game * settings.variables = [new SFS2X.SFSRoomVariable("desc", "Darts game, public, bestScore > 100")]; * * // Create the game * sfs.send(new SFS2X.CreateSFSGameRequest(settings)); * } * * function onRoomCreated(evtParams) * { * console.log("Room created: " + evtParams.room); * } * * function onRoomCreationError(evtParams) * { * console.log("Room creation failed: " + evtParams.errorMessage); * } * @param settings - An object containing the Game Room configuration settings. */ export class CreateSFSGameRequest { constructor(settings: SFSGameSettings); } /** * Creates a new InvitationReplyRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Users who receive an invitation sent by means of the InviteUsersRequest request can either accept or refuse it using this request. * The reply causes an invitationReply event to be dispatched to the inviter; if a reply is not sent, or it is sent after the invitation expiration, * the system will react as if the invitation was refused.

* *

If an error occurs while the reply is delivered to the inviter user (for example the invitation is already expired), * an invitationReplyError event is returned to the current user.

* @example * This example receives an invitation and accepts it automatically; in a real case scenario, the application interface usually allows the user choosing to accept or refuse the invitation, or even ignore it. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.INVITATION, onInvitationReceived, this); * sfs.addEventListener(SFS2X.SFSEvent.INVITATION_REPLY_ERROR, onInvitationReplyError, this); * } * * function onInvitationReceived(evtParams) * { * // Let's accept this invitation * sfs.send(new SFS2X.InvitationReplyRequest(evtParams.invitation, SFS2X.InvitationReply.ACCEPT)); * } * * function onInvitationReplyError(evtParams) * { * console.log("Failed to reply to invitation due to the following problem: " + evtParams.errorMessage); * } * @param invitation - An instance of the SFSInvitation class containing the invitation details (inviter, custom parameters, etc). * @param invitationReply - The answer to be sent to the inviter, among those available as constants in the InvitationReply class. * @param [params = null] - A SFSObject containing custom parameters to be returned to the inviter together with the reply (for example a message describing the reason of refusal). */ export class InvitationReplyRequest { constructor(invitation: SFSInvitation, invitationReply: number, params?: SFSObject); } /** * Creates a new InviteUsersRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sends a generic invitation to a list of users. * Invitations can be used for different purposes, such as requesting users to join a game or visit a specific Room, asking the permission to add them as buddies, etc. * Invited users receive the invitation as an invitation event dispatched to their clients: they can accept or refuse it * by means of the InvitationReplyRequest request, which must be sent within the specified amount of time.

* @param invitedUsers - A list of SFSUser objects, each representing a user to send the invitation to. * @param secondsForAnswer - The number of seconds available to each invited user to reply to the invitation (recommended range: 15 to 40 seconds). * @param [params = null] - An SFSObject containing custom parameters containing additional invitation details. */ export class InviteUsersRequest { constructor(invitedUsers: SFSUser[], secondsForAnswer: number, params?: SFSObject); } /** * Creates a new JoinRoomInvitationRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request invites other users/players to join a Room. Invited users receive the invitation as an invitation event dispatched to their clients: they can accept or refuse it * by means of the InvitationReplyRequest request, which must be sent within the specified amount of time. If the invitation is accepted, the client automatically joins the target Room.

* *

Depending on the Room's settings this invitation can be sent by the Room's owner only or by any other user in the Room. * This behavior can be set via the RoomSettings.allowOwnerOnlyInvitation parameter.

* *

NOTE: spectators in a Game Room are not allowed to invite other users; only players are.

* *

An invitation can also specify the amount of time given to each invitee to reply. Default is 30 seconds. A positive answer will attempt to join the user in the designated Room. * For Game Rooms the asSpectator flag can be toggled to join the invitee as player or spectator (default = player).

* *

There aren't any specific notifications sent back to the inviter after the invitee's response. Users that have accepted the invitation will join the Room while those * who didn't reply or turned down the invitation won't generate any event. In order to send specific messages (e.g. chat), just send a private message back to the inviter.

* @example * This example invites two more users in the current game. * function inviteMorePeople() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_ENTER_ROOM, onUserJoin, this); * * var invitedUsers = ["Fozzie", "Piggy"]; * var theRoom = sfs.getRoomByName("The Garden"); * * var params = new SFS2X.SFSObject(); * params.putUtfString("msg", "You are invited in this Room: " + theRoom.name); * * sfs.send(new SFS2X.JoinRoomInvitationRequest(theRoom, invitedUsers, params)); * } * * function onUserJoin(evtParams) * { * console.log("User joined Room: " + evtParams.user.name); * } * @param targetRoom - The Room to join (must have free user/player slots). * @param invitedUserNames - An array of user names to invite. * @param [params = null] - A SFSOobject containing any relevant parameter or message to be sent to the invited users (for example an invitation message). * @param [expirySeconds = 30] - The time given to the invitee to reply to the invitation. * @param [asSpectator = false] - In Game Rooms only, indicates if the invited user(s) should join as spectator(s) instead of player(s). */ export class JoinRoomInvitationRequest { constructor(targetRoom: SFSRoom, invitedUserNames: string[], params?: SFSObject, expirySeconds?: number, asSpectator?: boolean); } /** * Creates a new QuickJoinGameRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Using this request, by providing a matching expression and a list of Rooms or Groups, SmartFoxServer can search for a matching public Game Room * and immediately join the user into that Room as a player.

* *

If a game is found and can be joined, the roomJoin event is dispatched to the requester's client.

* @example * This example makes the current user join a Darts game with a "maximum bet" condition. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoin, this); * * // Create a matching expression to find a Darts game with a "maxBet" variable less than 100 * var exp = new SFS2X.MatchExpression("type", SFS2X.StringMatch.EQUALS, "darts").and("maxBet", SFS2X.NumberMatch.LESS_THAN, 100); * * // Search and join a public game within the "games" Group, leaving the last joined Room * sfs.send(new SFS2X.QuickJoinGameRequest(exp, ["games"], sfs.lastJoinedRoom)); * } * * function onRoomJoin(evtParams) * { * console.log("Successfully joined Room: " + evtParams.room); * } * @param matchExpression - A matching expression that the system will use to search a Game Room where to join the current user. If null is passed, the first available game Room is joined. * @param whereToSearch - An array of SFSRoom objects or an array of Group names to which the matching expression should be applied. The maximum number of elements that this array can contain is 32. * @param [roomToLeave = null] - A SFSRoom object representing the Room that the user should leave when joining the game. */ export class QuickJoinGameRequest { constructor(matchExpression: MatchExpression, whereToSearch: SFSRoom[], roomToLeave?: SFSRoom); } /** * Creates a new SetUserPositionRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

MMORooms represent virtual environments and can host any number of users. Based on their position, the system allows users within a certain range from each other (Area of Interest, or AoI) to interact.
* This request allows the current user to update his position inside the MMORoom, which in turn will trigger a proximityListUpdate event for all users that fall within his AoI.

* @example * This example changes the position of the user in a 2D coordinates space. * function updatePlayerPosition(px, py) * { * var newPos = new SFS2X.Vec3D(px, py); * sfs.send(new SFS2X.SetUserPositionRequest(newPos)); * } * @param pos - The user position. * @param [targetRoom = null] - The MMORoom object corresponding to the Room where the position should be set; if null, the last Room joined by the user is used. */ export class SetUserPositionRequest { constructor(pos: Vec3D, targetRoom?: MMORoom); } /** * Creates a new BanUserRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request banishes a user from the server. The current user must have administration or moderation privileges in order to be able to ban another user (see the SFSUser.privilegeId property). * The user can be banned by name or by IP address (see the BanMode class). Also, the request allows sending a message to the banned user * (to make clear the reason of the following disconnection) which is delivered by means of the moderatorMessage event.

* *

Differently from the user being kicked (see the KickUserRequest request), a banned user won't be able to connect to the SmartFoxServer instance until * the banishment expires (after 24 hours for client-side banning) or an administrator removes his name/IP address from the list of banned users * by means of the SmartFoxServer 2X Administration Tool.

* @example * This example bans the user Jack from the system. * function someMethod() * { * var userToBan = sfs.userManager.getUserByName("Jack"); * sfs.send(new SFS2X.BanUserRequest(userToBan.id)); * } * @param userId - The id of the user to be banned. * @param [message = null] - A custom message to be delivered to the user before banning him; if null, the default message configured in the SmartFoxServer 2X Administration Tool is used. * @param [banMode = BanMode.BY_NAME] - One of the ban modes defined in the BanMode class. * @param [delaySeconds = 5] - The number of seconds after which the user is banned after receiving the ban message. * @param [durationHours = 24] - The duration of the banishment, expressed in hours. */ export class BanUserRequest { constructor(userId: number, message?: string, banMode?: number, delaySeconds?: number, durationHours?: number); } /** * Creates a new ChangeRoomCapacityRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request changes the maximum number of users and/or spectators who can join a Room. * If the operation is successful, the roomCapacityChange event is dispatched to all the users * who subscribed the Group to which the target Room belongs, including the requester user himself. * If the user is not the creator (owner) of the Room, the roomCapacityChangeError event is fired. * An administrator or moderator can override this constrain (he is not requested to be the Room's owner).

* *

Please note that some limitations are applied to the passed values (i.e. a client can't set the max users to more than 200, or the max spectators to more than 32). * Also, if the Room was configured so that resizing is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

* *

In case the Room's capacity is reduced to a value less than the current number of users/spectators inside the Room, exceeding users are NOT disconnected.

* @example * This example changes the capacity of an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CAPACITY_CHANGE, onRoomCapacityChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CAPACITY_CHANGE_ERROR, onRoomCapacityChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * * // Resize the Room so that it allows a maximum of 100 users and zero spectators * sfs.send(new SFS2X.ChangeRoomCapacityRequest(theRoom, 100, 0)); * } * * function onRoomCapacityChanged(evtParams) * { * console.log("The capacity of Room " + evtParams.room.name + " was changed successfully"); * } * * function onRoomCapacityChangeError(evtParams) * { * console.log("Room capacity change failed: " + evtParams.errorMessage); * } * @param room - The Room object corresponding to the Room whose capacity should be changed. * @param newMaxUsers - The new maximum number of users/players who can join the Room. * @param newMaxSpect - The new maximum number of spectators who can join the Room (for Game Rooms only). */ export class ChangeRoomCapacityRequest { constructor(room: SFSRoom, newMaxUsers: number, newMaxSpect: number); } /** * Creates a new ChangeRoomNameRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request changes the name of a Room. If the renaming operation is successful, the roomNameChange event is dispatched to all the users * who subscribed the Group to which the target Room belongs, including the user who renamed it. * If the user is not the creator (owner) of the Room, or if the new name doesn't match the related criteria in Zone configuration, * the roomNameChangeError event is fired. An administrator or moderator can override this constrain (he is not requested to be the Room's owner).

*

If the Room was configured so that renaming is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

* @example * This example renames an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_NAME_CHANGE, onRoomNameChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_NAME_CHANGE_ERROR, onRoomNameChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * sfs.send(new SFS2X.ChangeRoomNameRequest(theRoom, "Gonzo The Great's Room")); * } * * function onRoomNameChanged(evtParams) * { * console.log("Room " + evtParams.oldName + " was successfully renamed to " + evtParams.room.name); * } * * function onRoomNameChangeError(evtParams) * { * console.log("Room name change failed: " + evtParams.errorMessage); * } * @param room - The SFSRoom object corresponding to the Room whose name should be changed. * @param newName - The new name to be assigned to the Room. */ export class ChangeRoomNameRequest { constructor(room: SFSRoom, newName: string); } /** * Creates a new ChangeRoomPasswordStateRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request not only changes the password of a Room, but also its "password state", which indicates if the Room is password protected or not.

* *

If the operation is successful, the roomPasswordStateChange event is dispatched to all the users * who subscribed the Group to which the target Room belongs, including the requester user himself. * If the user is not the creator (owner) of the Room, the roomPasswordStateChangeError event is fired. * An administrator or moderator can override this constrain (he is not requested to be the Room's owner).

*

If the Room was configured so that password change is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

* @example * This example changes the password of an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE, onRoomPasswordStateChanged, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR, onRoomPasswordStateChangeError, this); * * var theRoom = sfs.getRoomByName("Gonzo's Room"); * sfs.send(new SFS2X.ChangeRoomPasswordStateRequest(theRoom, "mammamia")); * } * * function onRoomPasswordStateChanged(evtParams) * { * trace("The password of Room " + evtParams.room.name + " was changed successfully"); * } * * function onRoomPasswordStateChangeError(evtParams) * { * trace("Room password change failed: " + evtParams.errorMessage); * } * @param room - The SFSRoom object corresponding to the Room whose password should be changed. * @param newPass - The new password to be assigned to the Room; an empty string or the null value can be passed to remove the Room's password. */ export class ChangeRoomPasswordStateRequest { constructor(room: SFSRoom, newPass: string); } /** * Creates a new CreateRoomRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request creates a new Room in the current Zone. If the creation is successful, * a roomAdd event is dispatched to all the users who subscribed the Group to which the Room is associated, including the Room creator. * Otherwise, a roomCreationError event is returned to the creator's client.

* @example * This example creates a new chat Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_ADD, onRoomCreated, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_CREATION_ERROR, onRoomCreationError, this); * * // Create a new chat Room * var settings = new SFS2X.RoomSettings("My Chat Room"); * settings.maxUsers = 40; * settings.groupId = "chats"; * * sfs.send(new SFS2X.CreateRoomRequest(settings)); * } * * function onRoomCreated(evtParams) * { * console.log("Room created: " + evtParams.room); * } * * function onRoomCreationError(evtParams) * { * console.log("Room creation failed: " + evtParams.errorMessage); * } * @param settings - An object containing the Room configuration settings. * @param [autoJoin = false] - If true, the Room is joined as soon as it is created. * @param [roomToLeave = null] - A SFSRoom object representing the Room that should be left if the new Room is auto-joined. */ export class CreateRoomRequest { constructor(settings: RoomSettings, autoJoin?: boolean, roomToLeave?: SFSRoom); } /** * Creates a new ExtensionRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request is used to send custom commands from the client to a server-side Extension, be it a Zone-level or Room-level Extension. * Viceversa, the extensionResponse event is used by the server to send Extension commands/responses to the client.

* *

Read the SmartFoxServer 2X documentation about server-side Extension for more informations.

* @example * This example sends a command to the Zone Extension; it also handles responses coming from the Extension by implementing the EXTENSION_RESPONSE listener (the same command name is used in both the request and the response). * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.EXTENSION_RESPONSE, onExtensionResponse, this); * * // Send two integers to the Zone extension and get their sum in return * var params = new SFS2X.SFSObject(); * params.putInt("n1", 26); * params.putInt("n2", 16); * * sfs.send(new SFS2X.ExtensionRequest("add", params)); * } * * function onExtensionResponse(evtParams) * { * if (evtParams.cmd == "add") * { * var responseParams = evtParams.params; * * // We expect an integer called "sum" * console.log("The sum is: " + responseParams.getInt("sum")); * } * } * @param extCmd - The name of the command, which identifies an action that should be executed by the server-side Extension. * @param [params = null] - An SFSObject containing custom data to be sent to the Extension. Can be null if no data needs to be sent. * @param [room = null] - If null, the specified command is sent to the current Zone server-side Extension; if not null, the command is sent to the server-side Extension attached to the passed Room. */ export class ExtensionRequest { constructor(extCmd: string, params?: SFSObject, room?: SFSRoom); } /** * Creates a new FindRoomsRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

By providing a matching expression and a search scope (a Group or the entire Zone), with this request it is possible to find those Rooms * matching the passed criteria on the server side and retrieve them by means of the roomFindResult event.

* @example * This example looks for all the server Rooms whose "country" Room Variable is set to "Sweden". * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_FIND_RESULT, onRoomFindResult, this); * * // Create a matching expression to find Rooms with a "country" variable equal to "Sweden" * var exp = new SFS2X.MatchExpression("country", SFS2X.StringMatch.EQUALS, "Sweden"); * * // Find the Rooms * sfs.send(new SFS2X.FindRoomsRequest(exp)); * } * * function onRoomFindResult(evtParams) * { * console.log("Rooms found: " + evtParams.rooms); * } * @param expr - A matching expression that the system will use to retrieve the Rooms. * @param [groupId = null] - The name of the Group where to search for matching Rooms; if null, the search is executed in the whole Zone. * @param [limit = 0] - The maximum size of the list of Rooms that will be returned by the roomFindResult event. If 0, all the found Rooms are returned. */ export class FindRoomsRequest { constructor(expr: MatchExpression, groupId?: string, limit?: number); } /** * Creates a new FindUsersRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

By providing a matching expression and a search scope (a Room, a Group or the entire Zone), with this request it is possible to find those users * matching the passed criteria on the server side and retrieve them by means of the userFindResult event.

* @example * This example looks for all the users whose "age" User Variable is greater than "29". * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_FIND_RESULT, onUserFindResult, this); * * // Create a matching expression to find users with an "age" variable greater than 29: * var exp = new SFS2X.MatchExpression("age", SFS2X.NumberMatch.GREATER_THAN, 29); * * // Find the users * sfs.send(new SFS2X.FindUserRequest(exp)); * } * * function onUserFindResult(evtParams) * { * console.log("Users found: " + evtParams.users); * } * @param expr - A matching expression that the system will use to retrieve the users. * @param [target = null] - The name of a Group or a single SFSRoom object where to search for matching users; if null, the search is executed in the whole Zone. * @param [limit = 0] - The maximum size of the list of users that will be returned by the userFindResult event. If 0, all the found users are returned. */ export class FindUsersRequest { constructor(expr: MatchExpression, target?: string | SFSRoom, limit?: number); } /** * Creates a new JoinRoomRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request joins the current user in a Room. If the operation is successful, the current user receives a roomJoin event; * otherwise the roomJoinError event is fired. This usually happens when the Room is full, or the password is wrong in case of password protected Rooms.

* *

Depending on the Room configuration defined upon its creation (see the RoomSettings.events setting), when the current user joins it, * the following events might be fired: userEnterRoom, dispatched to the other users inside the Room to warn them that a new user has arrived; * userCountChange, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of users inside the Room.

* @example * This example makes the user join an existing Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoined, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this); * * // Join a Room called "Lobby" * sfs.send(new SFS2X.JoinRoomRequest("Lobby")); * } * * function onRoomJoined(evtParams) * { * console.log("Room joined successfully: " + evtParams.room); * } * * function onRoomJoinError(evtParams) * { * console.log("Room joining failed: " + evtParams.errorMessage); * } * @param room - The id or the name of the Room to be joined. A SFSRoom object can be passed too. * @param [password = null] - The password of the Room, in case it is password protected. * @param [roomIdToLeave = null] - The id of a previously joined Room that the user should leave when joining the new Room. By default, the last joined Room is left; if a negative number is passed, no previous Room is left. * @param [asSpectator = false] - true to join the Room as a spectator (in Game Rooms only). */ export class JoinRoomRequest { constructor(room: number | string | SFSRoom, password?: string, roomIdToLeave?: number, asSpectator?: boolean); } /** * Creates a new KickUserRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request kicks a user out of the server. The current user must have administration or moderation privileges in order to be able to kick another user (see the SFSUser.privilegeId property). * The request allows sending a message to the kicked user (to make clear the reason of the following disconnection) which is delivered by means of the moderatorMessage event.

* *

Differently from the user being banned (see the BanUserRequest request), a kicked user will be able to reconnect to the SmartFoxServer instance immediately.

* @example * This example kicks the user Jack from the system. * function someMethod() * { * var userToKick = sfs.userManager.getUserByName("Jack"); * sfs.send(new SFS2X.KickUserRequest(userToKick.id)); * } * @param userId - The id of the user to be kicked. * @param [message = null] - A custom message to be delivered to the user before kicking him; if null, the default message configured in the SmartFoxServer 2X Administration Tool is used. * @param [delaySeconds = 5] - The number of seconds after which the user is kicked after receiving the kick message. */ export class KickUserRequest { constructor(userId: number, message?: string, delaySeconds?: number); } /** * Creates a new LeaveRoomRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request makes the current user leave one of the Rooms he joined. Depending on the Room configuration defined upon its creation * (see the RoomSettings.events setting), when the user leaves it, the following events might be fired: userExitRoom, * dispatched to all the users inside the Room (including the current user then) to warn them that a user has gone away; * userCountChange, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of users inside the Room.

* @example * This example makes the user leave the currently joined Room and handles the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_EXIT_ROOM, onUserExitRoom, this); * * // Leave the last joined Room * sfs.send(new SFS2X.LeaveRoomRequest()); * } * * function onUserExitRoom(evtParams) * { * var room = evtParams.room; * var user = evtParams.user; * * console.log("User " + user.name + " just left Room " + room.name); * } * @param [room = null] - The SFSRoom object corresponding to the Room that the current user must leave. If null, the last Room joined by the user is left. */ export class LeaveRoomRequest { constructor(room?: SFSRoom); } /** * Creates a new LoginRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This requests logs the current user in one of the server Zones. Each Zone represent an indipendent multiuser application governed by SmartFoxServer. * In order to join a Zone, a user name and password are usually required. If the user credentials must be validated, * a custom login process should be implemented in the Zone's server-side Extension.

* *

Read the SmartFoxServer 2X documentation about the login process for more informations.

* *

If the login operation is successful, the current user receives a login event; otherwise the loginError event is fired.

* @example * This example performs a login in the "BasicExamples" Zone. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.LOGIN, onLogin, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN_ERROR, onLoginError, this); * * // Login * sfs.send(new SFS2X.LoginRequest("FozzieTheBear", "", null, "BasicExamples")); * } * * function onLogin(evtParams) * { * console.log("Login successful!"); * } * * function onLoginError(evtParams) * { * console.log("Login failure: " + evtParams.errorMessage); * } * @param userName - The name to be assigned to the user. If not passed and if the Zone allows guest users, the name is generated automatically by the server. * @param [password = null] - The user password to access the system. SmartFoxServer doesn't offer a default authentication system, so the password must be validated implementing a custom login system in the Zone's server-side Extension. * @param [params = null] - An instance of SFSObject containing custom parameters to be passed to the Zone Extension (requires the custom login system to be active). * @param [zoneName = null] - The name (case-sensitive) of the server Zone to login to; if a Zone name is not specified, the client will use the setting passed to the SmartFox class constructor. */ export class LoginRequest { constructor(userName: string, password?: string, params?: SFSObject, zoneName?: string); } /** * Creates a new LogoutRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request logs the user out of the current server Zone. The user is notified of the logout operation by means of the logout event. * This doesn't shut down the connection, so the user will be able to login again in the same Zone or in a different one right after the confirmation event.

* @example * This example performs a logout from the current Zone. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.LOGOUT, onLogout, this); * * // Logout * sfs.send(new SFS2X.LogoutRequest()); * } * * function onLogout(evtParams) * { * trace("Logout executed!"); * } */ export class LogoutRequest { } /** * Creates a new ObjectMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sends an object containing custom data to the users in a Room. * The object is delivered to the selected users (or all users excluding the sender) inside the target Room by means of the objectMessage event. * It can be useful to send game data, like for example the target coordinates of the user's avatar in a virtual world.

* @example * This example sends the player's avatar movement coordinates and handles the respective event (note: the "myAvatar" instance is supposed to be the user sprite on the stage, while the "getUserAvatar()" method retrieves the sprite of other users' characters). * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.OBJECT_MESSAGE, onObjectMessage, this); * * // Send my movement to all players * var dataObj = new SFS2X.SFSObject(); * dataObj.putInt("x", myAvatar.x); * dataObj.putInt("y", myAvatar.y); * * sfs.send(new SFS2X.ObjectMessageRequest(dataObj)); * } * * function onObjectMessage(evtParams) * { * var dataObj = evtParams.message; * * var sender = evtParams.sender; * var avatar = getUserAvatar(sender.id); * * avatar.x = dataObj.get("x"); * avatar.y = dataObj.get("y"); * } * @param object - A SFSObject containing custom parameters to be sent to the message recipients. * @param [targetRoom = null] - The SFSRoom object corresponding to the Room where the message should be dispatched; if null, the last Room joined by the user is used. * @param [recipients = null] - A list of SFSUser objects corresponding to the message recipients; if null, the message is sent to all users in the target Room (except the sender himself). */ export class ObjectMessageRequest { constructor(object: SFSObject, targetRoom?: SFSRoom, recipients?: SFSUser[]); } /** * Creates a new PublicMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Using this request a public message is dispatched to all the users in the specified Room, including the message sender (this allows showing * chat messages in the correct order in the application interface); the corresponding event is the publicMessage event. * It is also possible to send an optional object together with the message: it can contain custom parameters useful to transmit, for example, additional * informations related to the message, like the text font or color, or other formatting details.

* *

In case the target Room is not specified, the message is sent in the last Room joined by the sender.

* *

NOTE: the publicMessage event is dispatched if the Room is configured to allow public messaging only (see the RoomSettings.permissions parameter).

* @example * This example sends a public message and handles the respective event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PUBLIC_MESSAGE, onPublicMessage, this); * * // Send a public message * sfs.send(new SFS2X.PublicMessageRequest("Hello everyone!")); * } * * function onPublicMessage(evtParams) * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var sender = evtParams.sender; * * if (sender == sfs.mySelf) * console.log("I said: " + evtParams.message); * else * console.log("User " + sender.name + " said: " + evtParams.message); * } * @param message - The message to be sent to all the users in the target Room. * @param [params = null] - A SFSObject containing additional custom parameters to be sent to the message recipients (for example the color of the text, etc). * @param [targetRoom = null] - The SFSRoom object corresponding to the Room where the message should be dispatched; if null, the last Room joined by the user is used. */ export class PublicMessageRequest { constructor(message: string, params?: SFSObject, targetRoom?: SFSRoom); } /** * Creates a new PrivateMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

Using this request a private message is dispatched to a specific user, who can be in any server Room, or even in no Room at all. * The message is delivered by means of the privateMessage event. * It is also returned to the sender: this allows showing the messages in the correct order in the application interface. * It is also possible to send an optional object together with the message: it can contain custom parameters useful to transmit, for example, additional * informations related to the message, like the text font or color, or other formatting details.

* @example * This example sends a private message and handles the respective event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PRIVATE_MESSAGE, onPrivateMessage, this); * * // Send a private message to Jack * var user = sfs.usermanager.getUserByName("Jack"); * sfs.send(new SFS2X.PrivateMessageRequest("Hello my friend!", user.id)); * } * * function onPrivateMessage(evtparams * { * // As messages are forwarded to the sender too, * // I have to check if I am the sender * * var sender = evtParams.sender; * * if (sender != sfs.mySelf) * console.log("User " + sender.name + " sent me this PM: " + evtParams.message); * } * @param message - The message to be sent to to the recipient user. * @param recipientId - The id of the user to which the message is to be sent. * @param [params = null] - A SFSObject containing additional custom parameters to be sent to the message recipient (for example the color of the text, etc). */ export class PrivateMessageRequest { constructor(message: string, recipientId: number, params?: SFSObject); } /** * Creates a new ModeratorMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sends a moderator message to a specific user or to a group of users. * The current user must have moderation privileges to be able to send the message (see the SFSUser.privilegeId property).

* *

The recipientMode parameter in the class constructor is used to determine the message recipients: a single user or all the * users in a Room, a Group or the entire Zone. Upon message delivery, the clients of the recipient users dispatch the moderatorMessage event.

* @example * This example sends a moderator message to all the users in the last joned Room; it also shows how to handle the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.MODERATOR_MESSAGE, onModeratorMessage, this); * * // Set the message recipients: all users in the current Room * var recipMode = new SFS2X.MessageRecipientMode(SFS2X.MessageRecipientMode.TO_ROOM, sfs.lastJoinedRoom); * * // Send the moderator message * sfs.send(new SFS2X.ModeratorMessageRequest("Hello everybody, I'm the Moderator!", recipMode)); * } * * function onModeratorMessage(evtParams) * { * console.log("The moderator sent the following message: " + evtParams.message); * } * @param message - The message of the moderator to be sent to the target user/s defined by the recipientMode parameter. * @param recipientMode - An instance of MessageRecipientMode containing the target to which the message should be delivered. * @param [params = null] - A SFSObject containing custom parameters to be sent to the recipient user/s. */ export class ModeratorMessageRequest { constructor(message: string, recipientMode: MessageRecipientMode, params?: SFSObject); } /** * Creates a new AdminMessageRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sends an administrator message to a specific user or to a group of users. * The current user must have administration privileges to be able to send the message (see the SFSUser.privilegeId property).

* *

The recipientMode parameter in the class constructor is used to determine the message recipients: a single user or all the * users in a Room, a Group or the entire Zone. Upon message delivery, the clients of the recipient users dispatch the adminMessage event.

* @example * This example sends an administration message to all the users in the Zone; it also shows how to handle the related event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ADMIN_MESSAGE, onAdminMessage, this); * * // Set the message recipients: all users in the Zone * var recipMode = new SFS2X.MessageRecipientMode(SFS2X.MessageRecipientMode.TO_ZONE, null); * * // Send the administrator message * sfs.send(new SFS2X.AdminMessageRequest("Hello to everybody from the Administrator!", recipMode)); * } * * function onAdminMessage(evtParams) * { * console.log("The administrator sent the following message: " + evtParams.message); * } * @param message - The message of the administrator to be sent to the target user/s defined by the recipientMode parameter. * @param recipientMode - An instance of MessageRecipientMode containing the target to which the message should be delivered. * @param [params = null] - An SFSObject containing custom parameters to be sent to the recipient user/s. */ export class AdminMessageRequest { constructor(message: string, recipientMode: MessageRecipientMode, params?: SFSObject); } /** * Creates a new PlayerToSpectatorRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request turns the current user from player to spectator in a Game Room. If the operation is successful, * all the users in the target Room are notified with the playerToSpectator event. * The operation could fail if no spectator slots are available in the Game Room at the time of the request; in this case * the playerToSpectatorError event is dispatched to the requester's client.

* @example * This example turns the current user from player to spectator in the last joined Game Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.PLAYER_TO_SPECTATOR, onPlayerToSpectatorSwitch, this); * sfs.addEventListener(SFS2X.SFSEvent.PLAYER_TO_SPECTATOR_ERROR, onPlayerToSpectatorSwitchError, this); * * // Switch player to spectator * sfs.send(new SFS2X.PlayerToSpectatorRequest()); * } * * function onPlayerToSpectatorSwitch(evtParams) * { * console.log("Player " + evtParams.user + " is now a spectator"); * } * * function onPlayerToSpectatorSwitchError(evtParams) * { * console.log("Unable to become a spectator due to the following error: " + evtParams.errorMessage); * } * @param [targetRoom = null] - The SFSRoom object corresponding to the Room in which the player should be turned to spectator. If null, the last Room joined by the user is used. */ export class PlayerToSpectatorRequest { constructor(targetRoom?: SFSRoom); } /** * Creates a new QuickJoinOrCreateRoomRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

SmartFoxServer searches for a public Room that meets the criteria expressed by the passed matching expression in the passed Room Groups. *

If no suitable Room can be found, a new Room is created, based on the passed settings. If a Room is created, the roomAdd event is dispatched to all the users who subscribed the Group to which the Room is associated, including the Room creator. In any case, if a Room to join could be found or was created, the roomJoin event is then dispatched.

*

Error conditions (Room creation error, Room join error) should always be checked adding the appropriate listeners.

* @example * This example makes the current user quickly join a Darts game with a "maximum bet" condition. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_ADD, onRoomAdd, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoin, this); * * // Create a matching expression to find a Darts game with a "maxBet" variable less than 100 * var exp = new SFS2X.MatchExpression("type", SFS2X.StringMatch.EQUALS, "darts").and("maxBet", SFS2X.NumberMatch.LESS_THAN, 100); * * // Set the Room settings to create a new Room if a matching one is not found * var settings = new SFS2X.RoomSettings(sfs.mySelf.name + "'s game"); * settings.groupId = "games"; * settings.isPublic = true; * settings.isGame = true; * settings.maxUsers = 10; * settings.minPlayersToStartGame = 2; * * // Set requirements to allow users find the Room (see match expression above) in Room Variables * var roomVars = []; * roomVars.push(new SFS2X.SFSRoomVariable("type", "Darts")); * roomVars.push(new SFS2X.SFSRoomVariable("maxBet", 50)); * settings.variables = roomVars; * * // Search (or create) and join a public Room within the "games" Group, leaving the last joined Room * sfs.send(new SFS2X.QuickJoinOrCreateRoomRequest(exp, ["games"], settings, sfs.lastJoinedRoom)); * } * * function onRoomAdd(evtParams) * { * console.log("Successfully created Room: " + evtParams.room); * } * * function onRoomJoin(evtParams) * { * console.log("Successfully joined Room: " + evtParams.room); * } * @param matchExpression - A matching expression that the system will use to search a Room where to join the current user. * @param groupList - An array of Group names to which the matching expression should be applied. * @param settings - An object containing the Room configuration settings. * @param [roomToLeave = null] - A SFSRoom object representing the Room that the user should leave when joining the game. */ export class QuickJoinOrCreateRoomRequest { constructor(matchExpression: MatchExpression, groupList: string[], settings: RoomSettings, roomToLeave?: SFSRoom); } /** * Creates a new SetRoomVariablesRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sets one or more custom Room Variables in a Room. When a Room Variable is set, the roomVariablesUpdate event * is dispatched to all the users in the target Room, including the user who updated it. * Also, if the Room Variable is global (see the SFSRoomVariable class description), the event is dispatched * to all users who subscribed the Group to which the target Room is associated.

* @example * This example sets a number of Room Variables and handles the respective update event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_VARIABLES_UPDATE, onRoomVarsUpdate, this); * * // Create some Room Variables * var roomVars = []; * roomVars.push(new SFS2X.SFSRoomVariable("gameStarted", false)); * roomVars.push(new SFS2X.SFSRoomVariable("gameType", "Snooker")); * roomVars.push(new SFS2X.SFSRoomVariable("minRank", 10)); * * sfs.send(new SFS2X.SetRoomVariablesRequest(roomVars)); * } * * function onRoomVarsUpdate(evtParams) * { * var changedVars = evtParams.changedVars; * var room = evtParams.room; * * // Check if the "gameStarted" variable was changed * if (changedVars.indexOf("gameStarted") != -1) * { * if (room.getVariable("gameStarted").value == true) * trace("Game started"); * else * trace("Game stopped"); * } * } * @param roomVariables - A list of SFSRoomVariable objects representing the Room Variables to be set. * @param [room = null] - A SFSRoom object representing the Room where to set the Room Variables; if null, the last Room joined by the current user is used. */ export class SetRoomVariablesRequest { constructor(roomVariables: SFSRoomVariable[], room?: SFSRoom); } /** * Creates a new SetUserVariablesRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request sets one or more User Variables for the current user. When a User Variable is set, the userVariablesUpdate event * is dispatched to all the users in all the Rooms joined by the current user, including himself.

* *

NOTE: the userVariablesUpdate event is dispatched to users in a specific Room only if * it is configured to allow this event (see the RoomSettings.permissions parameter).

* @example * This example sets a number of User Variables and handles the respective update event. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.USER_VARIABLES_UPDATE, onUserVarsUpdate, this); * * // Create some User Variables * var userVars = []; * userVars.push(new SFS2X.SFSUserVariable("avatarType", "SwedishCook")); * userVars.push(new SFS2X.SFSUserVariable("country", "Sweden")); * userVars.push(new SFS2X.SFSUserVariable("x", 10)); * userVars.push(new SFS2X.SFSUserVariable("y", 5)); * * sfs.send(new SFS2X.SetUserVariablesRequest(userVars)); * } * * function onUserVarsUpdate(evtParams) * { * var changedVars = evtParams.changedVars; * var user = evtParams.user; * * // Check if the user changed his x and y user variables * if (changedVars.indexOf("x") != -1 || changedVars.indexOf("y") != -1) * { * // Move the user avatar to a new position * ... * } * } * @param userVariables - A list of SFSUserVariable objects representing the User Variables to be set. */ export class SetUserVariablesRequest { constructor(userVariables: SFSUserVariable[]); } /** * Creates a new SpectatorToPlayerRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request turns the current user from spectator to player in a Game Room. If the operation is successful, * all the users in the target Room are notified with the spectatorToPlayer event. * The operation could fail if no player slots are available in the Game Room at the time of the request; in this case * the spectatorToPlayerError event is dispatched to the requester's client.

* @example * This example turns the current user from spectator to player in the last joined Game Room. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.SPECTATOR_TO_PLAYER, onSpectatorToPlayerSwitch, this); * sfs.addEventListener(SFS2X.SFSEvent.SPECTATOR_TO_PLAYER_ERROR, onSpectatorToPlayerSwitchError, this); * * // Switch spectator to player * sfs.send(new SFS2X.SpectatorToPlayerRequest()); * } * * function onSpectatorToPlayerSwitch(evtParams) * { * console.log("Spectator " + evtParams.user + " is now a player"); * } * * function onSpectatorToPlayerSwitchError(evtParams) * { * console.log("Unable to become a player due to the following error: " + evtParams.errorMessage); * } * @param [targetRoom = null] - The SFSRoom object corresponding to the Room in which the spectator should be turned to player. If null, the last Room joined by the user is used. */ export class SpectatorToPlayerRequest { constructor(targetRoom?: SFSRoom); } /** * Creates a new SubscribeRoomGroupRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request allows the user to be notified of specific Room events even if he didn't join the Room from which the events originated, provided the Room belongs to the subscribed Group.
* If the subscription operation is successful, the current user receives a roomGroupSubscribe event; otherwise the roomGroupSubscribeError event is fired.

* @example * This example makes the current user subscribe a Group. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_SUBSCRIBE, onGroupSubscribed, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR, onGroupSubscribeError, this); * * // Subscribe the "cardGames" group * sfs.send(new SFS2X.SubscribeRoomGroupRequest("cardGames")); * } * * function onGroupSubscribed(evtParams) * { * console.log("Group subscribed. The following rooms are now accessible: " + evtParams.newRooms); * } * * function onGroupSubscribeError(evtParams) * { * console.log("Group subscription failed: " + evtParams.errorMessage); * } * @param groupId - The name of the Room Group to subscribe. */ export class SubscribeRoomGroupRequest { constructor(groupId: string); } /** * Creates a new UnsubscribeRoomGroupRequest instance. * The instance must be passed to the SmartFox.send() method for the request to be executed. * *

This request allows the user to stop being notified of specific Room events occurring in Rooms belonging to the unsubscribed Group.
* If the operation is successful, the current user receives a roomGroupUnsubscribe event; otherwise the roomGroupUnsubscribeError event is fired.

* @example * This example makes the current user unsubscribe a Group. * function someMethod() * { * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_UNSUBSCRIBE, onGroupUnsubscribed, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR, onGroupUnsubscribeError, this); * * // Unsubscribe the "cardGames" group * sfs.send(new SFS2X.UnsubscribeRoomGroupRequest("cardGames")); * } * * function onGroupUnsubscribed(evtParams) * { * console.log("Group unsubscribed: " + evtParams.groupId); * } * * function onGroupUnsubscribeError(evtParams) * { * console.log("Group unsubscribing failed: " + evtParams.errorMessage); * } * @param groupId - The name of the Room Group to unsubscribe. */ export class UnsubscribeRoomGroupRequest { constructor(groupId: string); } /** * Developers never istantiate the SFSErrorCodes class: only use its static properties. */ export class SFSErrorCodes { /** * Sets the text of the error message corresponding to the passed error code. * *

NOTE: you have to make sure you maintain all the placeholders while modifying a message.

* @example * This example shows how to translate error 13 to French language retaining the required placeholders: * function someMethod() * { * SFS2X.SFSErrorCodes.setErrorMessage(13, "Le Groupe demandé n'est pas disponible - Salle: {0}; Groupe: {1}"); * } * @param code - The code of the error message to be modified. * @param message - The new error message, including the placeholders for runtime informations. */ static setErrorMessage(code: number, message: string): void; } /** * Developers never istantiate the LogLevel class: only use its static properties. */ export class LogLevel { constructor(); /** * A DEBUG message is a fine-grained information on the client activity. */ static readonly DEBUG: number; /** * An INFO message contains informations on the standard client activities. */ static readonly INFO: number; /** * A WARN message is a warning caused by an unexpected behavior of the client. *

Client operations are not compromised when a warning is raised.

*/ static readonly WARN: number; /** * An ERROR message contains informations on a problem that occurred during the client activities. *

Client operations might be compromised when an error is raised.

*/ static readonly ERROR: number; } /** * Developers never istantiate the LoggerEvent class: only use its static properties. * *

The constants contained in this class are used to register the logging event listeners; when an event is dispatched, an object containing the logged message is passed to the listener.

* @example * This example shows the approach to be implemented to listen to logging events. * var sfs = null; * * function init() * { * // Create SmartFox client instance * sfs = new SFS2X.SmartFox(); * * ... * * // Get a reference to the API internal logger * var logger = sfs.logger; * * // Enable logger events dispatching * logger.enableEventDispatching = true; * * // Add event listener to the logger * logger.addEventListener(SFS2X.LoggerEvent.ERROR, onErrorLogged, this); * * ... * } * * function onErrorLogged(evtParams) * { * // Write the error message in a log text area of the application interface * log.text += "The following error occurred: " + evtParams.message; * } */ export class LoggerEvent { constructor(); /** * The debug event type, dispatched when a low level message is logged by the SmartFoxServer 2X JavaScript API. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
messagestringThe logged debug message.
*/ static readonly DEBUG: string; /** * The info event type, dispatched when a standard informative message is logged by the SmartFoxServer 2X JavaScript API. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
messagestringThe logged informative message.
*/ static readonly INFO: string; /** * The warn event type, dispatched when a warning message is logged by the SmartFoxServer 2X JavaScript API. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
messagestringThe logged warning message.
*/ static readonly WARNING: string; /** * The error event type, dispatched when an error message is logged by the SmartFoxServer 2X JavaScript API. * * * * * *
The object passed to the listener contains the following parameters:
PropertyTypeDescription
messagestringThe logged error message.
*/ static readonly ERROR: string; } /** * Developers never istantiate the Logger class: this is done internally by the SmartFoxServer 2X API; get a reference to it using the SmartFox.logger property. * *

Accessing the logger instance allows to control the client-side logging level by means of the level property.

*/ export class Logger extends EventDispatcher { /** * Gets and sets the current logging level. * *

Debugging messages with a level lower than this value are not logged.
* The available log levels are contained in the LogLevel class. The default value is LogLevel.INFO.

*/ level: number; /** * Indicates whether or not the output of logged messages to the browser's console is enabled. * *

This property has no effect if the "console" object is undefined in the current environment.

*/ enableConsoleOutput: boolean; /** * Indicates whether dispatching of log events is enabled or not. */ enableEventDispatching: boolean; /** * Registers an event listener function that will receive notification of an event. * *

If you no longer need an event listener, remove it by calling the removeEventListener() method, or memory issues could arise. * In fact event listeners are not automatically removed from memory.

* @example * This example shows how to add a number of common event listeners to the SmartFox instance, usually during initialization: * function init() * { * sfs = new SFS2X.SmartFox(); * * // Add LoggerEvent listeners * sfs.logger.addEventListener(SFS2X.LoggerEvent.DEBUG, onDebugMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.INFO, onInfoMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.WARNING, onWarningMessage, this); * sfs.logger.addEventListener(SFS2X.LoggerEvent.ERROR, onErrorMessage, this); * * // Add SFSEvent listeners * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this); * sfs.addEventListener(SFS2X.SFSEvent.CONNECTION_LOST, onConnectionLost, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN_ERROR, onLoginError, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGIN, onLogin, this); * sfs.addEventListener(SFS2X.SFSEvent.LOGOUT, onLogout, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this); * sfs.addEventListener(SFS2X.SFSEvent.ROOM_JOIN, onRoomJoin, this); * } * @param evtType - The type of event to listen to, among those available in the SFSEvent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function that processes the event. This function should accept an object as its only parameter, which in turn contains the event parameters. * @param scope - The object that acts as a context for the event listener: it is the object that acts as a "parent scope" for the callback function, thus providing context (i.e. access to variables and other mehtods) to the function itself. */ addEventListener(evtType: string, callback: (...params: any[]) => any, scope: any): void; /** * Removes an event listener. * @param evtType - The type of event to remove, among those available in the SFSevent, SFSBuddyEvent and LoggerEvent classes. * @param callback - The listener function to be removed. */ removeEventListener(evtType: string, callback: (...params: any[]) => any): void; } /** * Developers never istantiate the ClientDisconnectionReason class: only use its static properties. */ export class ClientDisconnectionReason { constructor(); /** * Client was disconnected because it was idle for too long. *

The connection timeout depends on the server settings.

*/ static readonly IDLE: string; /** * Client was kicked out of the server. *

Kicking can occur automatically (i.e. for swearing, if the words filter is active) * or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).

*/ static readonly KICK: string; /** * Client was banned from the server. *

Banning can occur automatically (i.e. for flooding, if the flood filter is active) * or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).

*/ static readonly BAN: string; /** * The client manually disconnected from the server. *

The disconnect() method on the SmartFox class was called.

*/ static readonly MANUAL: string; /** * A generic network error occurred, and the client is unable to determine the cause of the disconnection. *

The server-side log should be checked for possible error messages or warnings.

*/ static readonly UNKNOWN: string; } /** * Developers never istantiate the PasswordUtil class: only use its static properties. */ export class PasswordUtil { /** * Generates the MD5 hash of a user password. * @example * This example performs a login with an hashed password: * function doLogin() * { * var userName = "testName"; * var userPass = "testPass"; * * var md5Pass = SFS2X.PasswordUtil.md5Password(userPass); * * sfs.send(new SFS2X.LoginRequest(userName, md5Pass, null, sfs.config.zone)); * } * @param pass - The plain text password. * @returns The hashed password. */ static md5Password(pass: string): string; }