SFSEvent

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);
}

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");
}

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
	}
}

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"));
	}
}

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);
}

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);
}

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!");
}

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
		...
	}
}

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);
}

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");
}

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);
}

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);
}

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
		...
	}
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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");
	}
}

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);
}

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");
}

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);
}

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);
}

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);
}

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
		...
	}
}