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.

Returns the current compression threshold.

This value represents the maximum message size (in bytes) before the protocol compression is activated. It is determined by the server configuration.

Returns the client configuration details. If the configuration hasn't been loaded yet, or passed to the connectWithConfig() method, a null object is returned.

See also

Returns the current connection mode after a connection has been successfully established. Possible values are defined as constants in the ConnectionMode class.

See also

         
         trace("Connection mode: ", sfs.connectionMode);
         

Returns the IP address of the SmartFoxServer 2X instance to which the client is connected.

See also

Returns the TCP port of the SmartFoxServer 2X instance to which the client is connected.

See also

Returns the Zone currently in use, if the user is already logged in.

See also

Indicates whether the client-server messages debug is enabled or not. If set to true, detailed debugging informations for all the incoming and outgoing messages are provided.

Debugging can be enabled when instantiating the SmartFox class too.

Returns the HTTP URI that can be used to upload files to SmartFoxServer 2X, using regular HTTP POST. For more details on how to use this functionality, see the Upload File tutorial.

NOTE: this property returns null if no API configuration has been set or the current user is not already logged in the server.

         
         private var fileRef:FileReference = new FileReference();
         
         private function someMethod():void
         {
             fileRef.addEventListener(Event.SELECT, onFileRefSelect);
             fileRef.addEventListener(Event.COMPLETE, onFileRefComplete);
         }
         
         private function onFileRefSelect(evt:Event):void
         {
             trace("File selected: " + fileRef.name);
              
             var req:URLRequest = new URLRequest(sfs.httpUploadURI);
             req.method = URLRequestMethod.POST;
              
             fileRef.upload(req);
         }
          
         private function onFileRefComplete(evt:Event):void
         {
             trace("Upload completed!")
         }
         

Indicates whether the client is connected to the server or not.

         
         trace("Am I connected?", sfs.isConnected);
         

Returns a list of Room objects representing the Rooms currently joined by the client.

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

See also

Returns the object representing the last Room joined by the client, if any. This property is null if no Room was joined.

NOTE: setting the lastJoinedRoom property manually can disrupt the API functioning. Use the JoinRoomRequest request to join a new Room instead.

See also

Returns a reference to the internal Logger instance used by SmartFoxServer 2X.

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.

Returns the User object representing the client 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.

See also

Returns a list of Room 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.

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 IRoomManager.getRoomList() method, accessible through the roomManager getter; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

See also

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 Room objects.

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 also

Indicates whether the UPD protocol is available or not in the current runtime. UPD is available in a ActionScript 3 client if it is executed in the Adobe AIR 2.0 (or higher) runtime only.

Using the UDP protocol in an application requires that a handshake is performed between the client and the server. By default this is NOT done by the SmartFoxServer 2X API, to avoid allocating resources that might never be used. In order to activate the UDP support, the initUDP() method must be invoked explicitly.

See also

Indicates whether the UDP handshake has been performed successfully or not.

See also

Indicates whether the client should attempt a tunnelled http connection through the BlueBox in case a socket connection can't be established.

NOTE: this property must be set before the connect() method is called. Also, after a connection is established, this property does not return the current connection mode (socket or http); for this purpose use the connectionMode property.

See also

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 User objects.

Returns the current version of the SmartFoxServer 2X ActionScript 3 API.

         
         trace("Current API version:", sfs.version);
         

Creates a new SmartFox instance.

See also

         
         var sfs:SmartFox = new SmartFox(true);
         

Establishes a connection between the client and a SmartFoxServer 2X instance. If no argument is passed, the client will use the settings loaded via loadConfig() method. In order to pass full connection settings without loading them from the external configuration file, use the connectWithConfig() method.

The client usually connects to a SmartFoxServer instance through a socket connection. In case a socket connection can't be established, and the useBlueBox property is set to true, a tunnelled http connection through the BlueBox module is attempted. When a successful connection is established, the connectionMode property can be used to check the current connection mode.

Parameters

See also

         
         sfs.connect("127.0.0.1", 9933);
         

Establishes a connection between the client and a SmartFoxServer 2X instance. The connection details (IP, port, etc) are contained in the passed object.

This is an alternative version of the connect() method. Read the method description for more informations.

Parameters

See also

Closes the connection between the client and the SmartFoxServer 2X instance.

See also

Enables the automatic realtime monitoring of the lag between the client and the server (round robin). When turned on, the SFSEvent.PING_PONG 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 performed successfully only.

Parameters

See also

Retrieves a Room object from its id.

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

Parameters

See also

         
         var roomId:int = 3;
         var room:Room = sfs.getRoomById(roomId);
         trace("The name of Room", roomId, "is", room.name);
         

Retrieves a Room object from its name.

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

Parameters

See also

         
         var roomName:String = "The Lobby";
         var room:Room = sfs.getRoomByName(roomName);
         trace("The ID of Room '", roomName, "' is", room.id);
         

Retrieves the list of Rooms which are part of the specified Room Group.

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

Parameters

See also

Initializes the connection cryptography. Once this process is successfully completed all of the server's data will be encrypted using standard AES 128-bit algorithm, with a secure key served over HTTPS.

NOTE: this call must be executed right after a successful connection, before the login is performed.

See also

         var sfs:SmartFox = new SmartFox();
         sfs.addEventListener(SFSEvent.CONNECTION, onConnect);
         sfs.addEventListener(SFSEvent.CRYPTO_INIT, onCryptInit);
         
         sfs.connect("mysecuredomain.com", 9933);
         
         function onConnect(evt:SFSEvent):void
         {
             if (evt.param.success)
                 sfs.initCrypto();
                 
             else
                 trace("Sorry, connection failed");
         }
         
         function onCryptInit(evt:SFSEvent):void
         {
             ta_data.text = evt.params.success;
             
             if (evt.params.success)
                 sfs.send(new LoginRequest("MyName", "MyPassword", "MyZone"));
         
             else
                 trace("Crypto init failed. Caused by: " + evt.params.errorMsg)
         }
         

Initializes the UDP protocol by performing an handshake with the server. In ActionScript 3, the UDP protocol is available exclusively if the client is executed in the Adobe AIR 2.0 (or higher) runtime. In order to properly activate the UDP support for the AIR runtime, an instance of the AirUDPManager class contained in the SmartFoxServer 2X ActionScript 3 API must be provided. Also, if udpHost or udpPort arguments are not passed, the client will use the settings loaded via loadConfig() method.

This method needs to be called only once. It can be executed at any moment provided that a connection to the server has already been established. After a successful initialization, UDP requests can be sent to the server-side Extension at any moment.

MTU note

The Maximum Transmission Unit (MTU), represents the largest amount of bytes that can be sent at once before packet fragmentation occurs. Since the UDP protocol uses a "nothing-or-all" approach to the transmission, it is important to keep in mind that, on average, a message size of 1100-1200 bytes is probably the maximum you can reach. If you exceed the MTU size the data will be "lost in hyperspace" (the Internet).

Another interesting matter is that there is no fixed size for the MTU, because each operating system uses a slightly different value. Because of this we suggest a conservative data size of 1000-1200 bytes per packet, to avoid packet loss. The SFS2X protocol compression allows to send 2-3KBytes of uncompressed data, which usually is squeezed down to a size of ~1000 bytes. If you have a larger amount of data to send, we suggest you to organize it in smaller chunks so that they don't exceed the suggested MTU size.

More details about the MTU can be found at the page linked below.

Parameters

See also

         
         private function someMethod():void
         {
             sfs.addEventListener(SFSEvent.UDP_INIT, onUDPInit);
             sfs.initUDP(new AirUDPManager());
         }
         
         private function onUDPInit(evt:SFSEvent):void
         {
             if (evt.params.success)
             {
                 // Connection successful: execute an Extension call via UDP
                 sfs.send( new ExtensionRequest("udpTest", new SFSObject(), null, true) );
             }
             else
             {
                 trace("UDP initialization failed!");
             }
         }
         

Simulates an abrupt disconnection from the server. This method should be used for testing and simulations only, otherwise use the disconnect() method.

See also

Loads the client configuration file.

The SmartFox instance can be configured through an external XML configuration file loaded at run-time. By default, the loadConfig() method loads a file named "sfs-config.xml", placed in the same folder of the application swf file. If the connectOnSuccess argument is set to true, on loading completion the connect() method is automatically called by the API, otherwise the SFSEvent.CONFIG_LOAD_SUCCESS event type is dispatched. In case of loading error, the SFSEvent.CONFIG_LOAD_FAILURE event type id fired.

In order to pass full connection settings without loading them from the external configuration file, use the connectWithConfig() method.

The external XML configuration file has the following structure; ip, port and zone parameters are mandatory, all other parameters are optional:

         
         <!-- SFS2X Client Configuration file -->
         <SmartFoxConfig>
             <ip>127.0.0.1</ip>
             <port>9933</port>
             <zone>SimpleChat</zone>
             
             <debug>true</debug>
             
             <udpIp>127.0.0.1</udpIp>
             <udpPort>9934</udpPort>
             
             <httpPort>8080</httpPort>
             <httpsPort>8443</httpsPort>
         
             <useBlueBox>true</useBlueBox>
             <forceBlueBoxOverHttps>false</forceBlueBoxOverHttps>
             <blueBoxPollingRate>500</blueBoxPollingRate>
         </SmartFoxConfig>
         

Parameters

See also

         
         private function someMethod():void
         {
             var sfs:SmartFox = new SmartFox();
             
             sfs.addEventListener(SFSEvent.CONFIG_LOAD_SUCCESS, onConfigLoaded);
             sfs.addEventListener(SFSEvent.CONFIG_LOAD_FAILURE, onConfigLoadFailed);
             
             sfs.loadConfig("testConfig.xml", false);
         }
         
         private function onConfigLoaded(evt:SFSEvent):void
         {
             // Configuration loaded successfully, now connect
             sfs.connect();
         }
         
         private function onConfigLoadFailed(evt:SFSEvent):void
         {
             trace("Failed loading configuration file");
         }
         

Sends a request to the server. All the available request objects can be found in the requests package.

Parameters

See also

         
         sfs.send( new LoginRequest("KermitTheFrog", "KermitPass", "TheMuppetZone") );
         

         
         sfs.send( new JoinRoomRequest("Lobby") );
         

         
         var params:ISFSObject = new SFSObject();
         params.putInt("x", 10);
         params.putInt("y", 37);
         
         sfs.send( new ExtensionRequest("setPosition", params) );
         

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 the generic "Flash" label is used as platform, without specifying the version.

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

Parameters

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a buddy is added successfully to the current user's buddies list. This event is fired in response to the AddBuddyRequest request in case the operation is executed successfully.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

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 IBuddyManager.myState property). 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 IBuddyManager.myOnlineState property) determines if the user will appear online or not to other users who have him in their buddies list.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a buddy in the current user's buddies 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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a buddy is removed successfully from the current user's buddies list. This event is fired in response to the RemoveBuddyRequest request in case the operation is executed successfully.

The properties of the params object contained in the event object have the following values:

See also

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), the isItMe parameter should be used to check if the current user is the one who updated his own Buddy Variables.

The properties of the params object contained in the event object have the following values:

See also

Dispatched if an error occurs while loading the external client configuration file. This event is fired in response to a call to the loadConfig() method, typically when the configuration file is not found or it isn't accessible (no read permissions).

No parameters are available for this event object.

See also

Dispatched when the external client configuration file is loaded successfully. This event is fired in response to a call to the loadConfig() method, but only if the connectOnSuccess argument of the loadConfig() method is set to false; otherwise the connection is attempted and the related SFSEvent.CONNECTION event type is fired.

No parameters are available for this event object.

See also

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 connect() method.

The properties of the params object contained in the event object have the following values:

See also

Dispatched when the client cannot establish a socket connection to the server and the useBlueBox parameter is active in the configuration.

The event can be used to notify the user that a second connection attempt is running, using the BlueBox (HTTP tunnelling).

No parameters are available for this event object.

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 disconnect() method.

The properties of the params object contained in the event object have the following values:

See also

Dispatched when the connection between the client and the SmartFoxServer 2X instance is re-established after a temporary disconnection, while the SmartFoxServer 2X HRC system is available in the Zone.

The HRC system allows a broken connection to be re-established transparently within a certain amount of time, without loosing any of the current application state. For example this allows any player to get back to a game without loosing the match because of a sloppy internet connection.

When this event is dispatched the application interface should be reverted to the state it had before the disconnection. In case the reconnection attempt fails, the connectionLost event is fired.

No parameters are available for this event object.

See also

Dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted abruptly while the SmartFoxServer 2X HRC system is available in the Zone.

The HRC system allows a broken connection to be re-established transparently within a certain amount of time, without loosing any of the current application state. For example this allows any player to get back to a game without loosing the match because of a sloppy internet connection.

When this event is dispatched the API enter a "freeze" mode where no new requests can be sent until the reconnection is successfully performed. It is highly recommended to handle this event and freeze the application interface accordingly until the connectionResume event is fired, or the reconnection fails and the user is definitely disconnected and the connectionLost event is fired.

No parameters are available for this event object.

See also

Dispatched in return to the initialization of an encrypted connection. This event is fired in response to a call to the initCrypto() method.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when the current user receives an invitation from another user. This event is caused by the InviteUsersRequest request; the user is supposed to reply using the InvitationReplyRequest request.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when the current user performs a successful login in a server Zone. This event is fired in response to the LoginRequest request.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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.

See also

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 properties of the params object contained in the event have the following values:

See also

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 performed through the SmartFoxServer 2X Administration Tool.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when one more users or one or more MMOItem objects enter/leave the current user's Area of Interest in MMORooms. 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 SFSEvent.USER_ENTER_ROOM and SFSEvent.USER_EXIT_ROOM events available in regular Rooms.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a Rooms search is completed. This event is fired in response to the FindRoomsRequest request to return the search result.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the Zone.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when a low level socket error is detected, for example bad/inconsistent data.

The properties of the params object contained in the event object have the following values:

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 properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

Dispatched when the result of the UDP handshake is notified. This event is fired in response to a call to the initUDP() method.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also

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 SFSEvent.PROXIMITY_LIST_UPDATE event.

The properties of the params object contained in the event object have the following values:

See also

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 SFSEvent.PROXIMITY_LIST_UPDATE event.

The properties of the params object contained in the event object have the following values:

See also

Dispatched when a users search is completed. This event is fired in response to the FindUsersRequest request to return the search result.

The properties of the params object contained in the event object have the following values:

See also

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 properties of the params object contained in the event object have the following values:

See also