SFSEvent

var sfs = null;

function init()
{
	// Create SmartFox client instance
	sfs = new SmartFox();

	// Add event listener for connection
	sfs.addEventListener(SFSEvent.CONNECTION, onConnection, this);

	// Connect to the server
	sfs.connect("127.0.0.1", 8080);
}

// Handle connection event
function onConnection(evtParams)
{
	const success = evtParams[EventParam.Success];
	
	if (success)
		console.log("Connected to SmartFoxServer");
	else
		console.log("Connection failed; is the server running at all?");
}

Event type dispatched when the client receives a message from an administrator User.

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

Event type dispatched when a connection between the client and a SmartFoxServer instance is attempted.

This event is fired in response to a call to the SmartFox#connect method. The connection attempt can fail if the server is unreachable for some reason, or if an error occurs during the handshake process. In this case an error message is provided.

Event type dispatched when the connection between the client and the SmartFoxServer instance is interrupted.

This event is fired in response to a call to the SmartFox#disconnect method, or when the connection between the client and the server is interrupted for other reasons.

Event type dispatched when the SmartFoxServer HRC System is active in the currently joined Zone and the connection between the client and the SmartFoxServer instance is re-established.

Event type dispatched when the SmartFoxServer HRC System is active in the currently joined Zone and the connection between the client and the SmartFoxServer instance is interrupted abruptly.

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

When this event is dispatched the API enter a "freeze" mode during which 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 SFSEvent.CONNECTION_RESUME event is fired, or the reconnection fails, the client is definitely disconnected and the SFSEvent.CONNECTION_LOST event is fired.

Event type dispatched when data coming from a server-side Extension is received by the client.

Data is usually sent by the server to one or more clients in response to an ExtensionRequest, but not necessarily. If this event is fired in response to a request sent by the client, it is common practice to use the same value of the cmd parameter passed to the request also in the response.

Event type dispatched when the client receives an Invitation.

This event is caused by the InviteUsersRequest and the client is supposed to reply by means of the InvitationReplyRequest.

The event can also be fired when a CreateSFSGameRequest is sent and its settings cause Invitations to join the Game Room to be dispatched.

Event type dispatched when the client receives a reply to a previously sent Invitation.

This event is caused by the InvitationReplyRequest sent by the invited User.

Event type dispatched when an error occurs while the client is sending a reply to an Invitation.

This event is fired in response to the InvitationReplyRequest if the operation fails.

Event type dispatched when the client performs a successful login in a server Zone.

This event is fired in response to the LoginRequest if the operation is successful.

Event type dispatched when an error occurs during the login process.

This event is fired in response to the LoginRequest if the operation fails.

Event type dispatched when the client logs out from the server Zone.

This event is fired in response to the LogoutRequest request.

Event type dispatched when one or more MMOItem Variables are created or updated.

This event is caused by MMOItem Variable/s being set, updated or deleted in a server-side Extension. It is received by the client if the relative MMOItem is inside its Area of Interest only.

Event type dispatched when the client receives a message from a moderator User.

This event can be caused by the ModeratorMessageRequest, the KickUserRequest or the BanUserRequest sent by a User with at least moderation privileges. Also, this event can be caused by a kick/ban action executed in the SmartFoxServer Administration Tool.

Event type dispatched when an object containing custom data is received by the client.

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

Event type dispatched when a new lag value is measured.

This event is fired continuously when the automatic lag monitoring is active (see SmartFox#enableLagMonitor method).

Event type dispatched when a Player is turned into Spectator inside a Game Room.

This event is fired in response to the PlayerToSpectatorRequest if the operation is successful.

Event type dispatched when an error occurs while the client is being turned from Player to Spectator in a Game Room.

This event is fired in response to the PlayerToSpectatorRequest if the operation fails.

Event type dispatched when a private message is received by the client.

This event is caused by a PrivateMessageRequest sent by any User in the logged Zone.

The same event is fired by the sender's client too, so that the application 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 the recipient to which the message was originally sent. 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 modals or tabs (and we need to write its own message in the proper one), the data parameter can be used to store, for example, the id of the recipient User.

Event type dispatched when one or more Users or MMOItems enter/leave the client's Area of Interest in a MMORoom.

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

Note that this event substitutes the default SFSEvent.USER_ENTER_ROOM and SFSEvent.USER_EXIT_ROOM events available in regular Rooms.

Event type dispatched when a public message is received by the client.

This event is caused by a PublicMessageRequest sent by any User in the target Room, including the current one.

Event type dispatched when a new Room is created inside the logged Zone under any of the Room Groups that the client subscribed.

This event is fired in response to the CreateRoomRequest and the CreateSFSGameRequest if the respective operations are successful.

Event type dispatched when the capacity of a Room in the currently joined Zone is changed.

This event is fired in response to the ChangeRoomCapacityRequest if the operation is successful.

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 if the operation fails.

Event type dispatched if an error occurs while creating a new Room. This event is fired in response to the CreateRoomRequest and the CreateSFSGameRequest if the operation fails.

Event type dispatched when a Room search is executed.

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

Event type dispatched when a Group is subscribed by the client.

This event is fired in response to the SubscribeRoomGroupRequest if the operation is successful.

Event type dispatched when an error occurs while a Room Group is being subscribed.

This event is fired in response to the SubscribeRoomGroupRequest if the operation fails.

Event type dispatched when a Group is unsubscribed by the client.

This event is fired in response to the UnsubscribeRoomGroupRequest if the operation is successful.

Event type dispatched when an error occurs while a Room Group is being unsubscribed.

This event is fired in response to the UnsubscribeRoomGroupRequest if the operation fails.

Event type dispatched when a Room is joined by the client.

This event is fired in response to the JoinRoomRequest and QuickJoinGameRequest if the respective operations are successful.

Event type dispatched when an error occurs while the client is trying to join a Room.

This event is fired in response to the JoinRoomRequest if the operation fails.

Event type dispatched when the name of a Room in the currently joined Zone is changed.

This event is fired in response to the ChangeRoomNameRequest if the operation is successful.

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 if the operation fails.

Event type dispatched when the password of a Room in the currently joined Zone is set, changed or removed.

This event is fired in response to the ChangeRoomPasswordStateRequest if the operation is successful.

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 if the operation fails.

Event type dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the logged Zone.

Event type dispatched when one or more Room Variables are created or updated.

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

Event type dispatched when a Spectator is turned into Player inside a Game Room.

This event is fired in response to the SpectatorToPlayerRequest if the operation is successful.

Event type dispatched when an error occurs while the client is being turned from Spectator to Player in a Game Room.

This event is fired in response to the SpectatorToPlayerRequest if the operation fails.

Event type dispatched when the number of Users/Players or Spectators inside a Room changes.

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

Event type dispatched when one of the Rooms joined by the client is entered by another User.

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

Note that if the Room is of type MMORoom, this event type is never fired and it is substituted by the SFSEvent.PROXIMITY_LIST_UPDATE event type.

Event type dispatched when one of the Rooms joined by the client is left by a User, including the current one.

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

Note that if the Room is of type MMORoom, this event type is never fired and it is substituted by the SFSEvent.PROXIMITY_LIST_UPDATE event type.

Event type dispatched when a User search is executed.

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

Event type dispatched when one or more User Variables are created or updated.

This event is caused by the SetUserVariablesRequest sent by a User in one of the Rooms joined by the client.