rubyfox-server 2.13.5.1 → 2.16.0.1

data/lib/rubyfox/server/data/lib/js/LibApi.js

@@ -619,6 +619,25 @@ SFSApi.prototype.checkSecurePassword = function(session, originalPass, encrypted
 	return this._javaApi.checkSecurePassword(session, originalPass, encryptedPass);
 }
 
+/*
+ * Logs a client into a Zone, turning its <em>Session</em> object into a <em>SFSUser</em> object.
+ *
+ * @param	{Session} session		The client's <img src="java-icon-small.png"></img> [Session]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/bitswarm/sessions/Session.html} object, usually provided by the <img src="java-icon-small.png"></img> [SFSEventType.USER_LOGIN]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/core/SFSEventType.html#USER_LOGIN} event.
+ * @param	{string} name			The user name.
+ * @param	{string} pass			The user password.
+ * @param	{string} zoneName		The name of the Zone to join.
+ * @param	{SFSObject} params		A <em>SFSObject</em> containing the custom parameters to be sent back to the client, attached to the client-side <em>LOGIN</em> event.
+ * @param	{boolean} forceLogout	If a user with the same name is already logged in the system and <code>true</code> is passed, that user will be disconnected before logging in the new user.
+ *
+ * @return {SFSUser} The <img src="java-icon-small.png"></img> [SFSUser]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/entities/SFSUser.html} object representing the logged-in user.
+ */
+/*
+SFSApi.prototype.login = function(session, name, pass, zoneName, params, forceLogout)
+{
+	return this._javaApi.login(session, name, pass, zoneName, params, forceLogout)
+}
+*/
+
 /**
  * Logs a user out of the current Zone.
  *
@@ -781,16 +800,7 @@ SFSApi.prototype.disconnectSession = function(session)
  */
 SFSApi.prototype.createRoom = function(zone, settings, owner, joinIt, roomToLeave, fireClientEvent, fireServerEvent)
 {
-	return this._javaApi.createRoom
-	(
-		zone,
-		settings,
-		(owner === undefined ? null : owner),
-		(joinIt === undefined ? false : joinIt),
-		(roomToLeave === undefined ? null : roomToLeave),
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	return this._javaApi.createRoom(zone, settings, owner, joinIt, roomToLeave, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -896,16 +906,11 @@ SFSApi.prototype.getUserBySession = function(session)
  */
 SFSApi.prototype.joinRoom = function(user, roomToJoin, password, asSpectator, roomToLeave, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.joinRoom
-	(
-		user,
-		roomToJoin,
-		(password === undefined ? null : password),
-		(asSpectator === undefined ? false : asSpectator),
-		(roomToLeave === undefined ? null : roomToLeave),
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	// Switch from JS undefined to Java null
+	if (roomToLeave == undefined)
+		roomToLeave = null;
+
+	this._javaApi.joinRoom(user, roomToJoin, password, asSpectator, roomToLeave, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -918,13 +923,7 @@ SFSApi.prototype.joinRoom = function(user, roomToJoin, password, asSpectator, ro
  */
 SFSApi.prototype.leaveRoom = function(user, room, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.leaveRoom
-	(
-		user,
-		room,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.leaveRoom(user, room, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -936,12 +935,7 @@ SFSApi.prototype.leaveRoom = function(user, room, fireClientEvent, fireServerEve
  */
 SFSApi.prototype.removeRoom = function(room, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.removeRoom
-	(
-		room,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.removeRoom(room, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -956,13 +950,7 @@ SFSApi.prototype.removeRoom = function(room, fireClientEvent, fireServerEvent)
  */
 SFSApi.prototype.sendPublicMessage = function(targetRoom, sender, message, params)
 {
-	this._javaApi.sendPublicMessage
-	(
-		targetRoom,
-		sender,
-		message,
-		(params === undefined ? null : params)
-	);
+	this._javaApi.sendPublicMessage(targetRoom, sender, message, params);
 }
 
 /**
@@ -977,13 +965,7 @@ SFSApi.prototype.sendPublicMessage = function(targetRoom, sender, message, param
  */
 SFSApi.prototype.sendPrivateMessage = function(sender, recipient, message, params)
 {
-	this._javaApi.sendPrivateMessage
-	(
-		sender,
-		recipient,
-		message,
-		(params === undefined ? null : params)
-	);
+	this._javaApi.sendPrivateMessage(sender, recipient, message, params);
 }
 
 /**
@@ -1041,13 +1023,7 @@ SFSApi.prototype.sendObjectMessage = function(targetRoom, sender, message, recip
 	if (recipients instanceof Array)
 		recipients = $$Util.toList(recipients);
 
-	this._javaApi.sendObjectMessage
-	(
-		targetRoom,
-		sender,
-		message,
-		(recipients === undefined ? null : recipients)
-	);
+	this._javaApi.sendObjectMessage(targetRoom, sender, message, recipients);
 }
 
 /**
@@ -1092,15 +1068,7 @@ SFSApi.prototype.setRoomVariables = function(user, targetRoom, variables, fireCl
 	if (variables instanceof Array)
 		variables = $$Util.toList(variables);
 
-	this._javaApi.setRoomVariables
-	(
-		user,
-		targetRoom,
-		variables,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent),
-		(overrideOwnership === undefined ? false : overrideOwnership)
-	);
+	this._javaApi.setRoomVariables(user, targetRoom, variables, fireClientEvent, fireServerEvent, overrideOwnership);
 }
 
 /**
@@ -1147,13 +1115,7 @@ SFSApi.prototype.setUserVariables = function(owner, variables, fireClientEvent,
 	if (variables instanceof Array)
 		variables = $$Util.toList(variables);
 
-	this._javaApi.setUserVariables
-	(
-		owner,
-		variables,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.setUserVariables(owner, variables, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1241,13 +1203,7 @@ SFSApi.prototype.unsubscribeRoomGroup = function(user, groupId)
  */
 SFSApi.prototype.spectatorToPlayer = function(user, targetRoom, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.spectatorToPlayer
-	(
-		user,
-		targetRoom,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.spectatorToPlayer(user, targetRoom, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1262,13 +1218,7 @@ SFSApi.prototype.spectatorToPlayer = function(user, targetRoom, fireClientEvent,
  */
 SFSApi.prototype.playerToSpectator = function(user, targetRoom, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.playerToSpectator
-	(
-		user,
-		targetRoom,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.playerToSpectator(user, targetRoom, fireClientEvent, fireServerEvent);
 }
 
 //==============================================================================
@@ -1301,7 +1251,7 @@ BuddyApi = function()
  *
  * <p>This causes saved data (the list of buddies and their persistent Buddy Variables) to be loaded from the Buddy List storage.</p>
  *
- * @param	{SFSUser} user						The <img src="java-icon-small.png"></img> [SFSUser]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/entities/SFSUser.html} object representing the user whose Buddy List should be loaded.
+ * @param	{SFSUser} user		The <img src="java-icon-small.png"></img> [SFSUser]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/entities/SFSUser.html} object representing the user whose Buddy List should be loaded.
  * @param	{boolean} [fireServerEvent=false]	If <code>true</code>, a server-side event of type <img src="java-icon-small.png"></img> [SFSEventType.BUDDY_LIST_INIT]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/core/SFSEventType.html#BUDDY_LIST_INIT} will be fired to notify the Buddy List initialization success.
  *
  * @return {SFSBuddyList} A <img src="java-icon-small.png"></img> [SFSBuddyList]{@link http://docs2x.smartfoxserver.com/api-docs/javadoc/server/com/smartfoxserver/v2/buddylist/SFSBuddyList.html} class instance representing the usere's Buddy List.
@@ -1310,11 +1260,7 @@ BuddyApi = function()
  */
 BuddyApi.prototype.initBuddyList = function(user, fireServerEvent)
 {
-	return this._javaApi.initBuddyList
-	(
-		user,
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	return this._javaApi.initBuddyList(user, fireServerEvent);
 }
 
 /**
@@ -1328,12 +1274,7 @@ BuddyApi.prototype.initBuddyList = function(user, fireServerEvent)
  */
 BuddyApi.prototype.goOnline = function(user, online, fireServerEvent)
 {
-	this._javaApi.goOnline
-	(
-		user,
-		online,
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.goOnline(user, online, fireServerEvent);
 }
 
 /**
@@ -1349,14 +1290,7 @@ BuddyApi.prototype.goOnline = function(user, online, fireServerEvent)
  */
 BuddyApi.prototype.addBuddy = function(owner, buddyName, isTemp, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.addBuddy
-	(
-		owner,
-		buddyName,
-		isTemp,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.addBuddy(owner, buddyName, isTemp, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1377,13 +1311,7 @@ BuddyApi.prototype.setBuddyVariables = function(owner, variables, fireClientEven
 	if (variables instanceof Array)
 		variables = $$Util.toList(variables);
 
-	this._javaApi.setBuddyVariables
-	(
-		user,
-		variables,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.setBuddyVariables(user, variables, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1396,13 +1324,7 @@ BuddyApi.prototype.setBuddyVariables = function(owner, variables, fireClientEven
  */
 BuddyApi.prototype.removeBuddy = function(owner, buddyName, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.removeBuddy
-	(
-		owner,
-		buddyName,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.removeBuddy(owner, buddyName, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1418,14 +1340,7 @@ BuddyApi.prototype.removeBuddy = function(owner, buddyName, fireClientEvent, fir
  */
 BuddyApi.prototype.blockBuddy = function(owner, buddyName, isBlocked, fireClientEvent, fireServerEvent)
 {
-	this._javaApi.blockBuddy
-	(
-		owner,
-		buddyName,
-		isBlocked,
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	this._javaApi.blockBuddy(owner, buddyName, isBlocked, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1516,14 +1431,7 @@ GameApi = function()
  */
 GameApi.prototype.createGame = function(zone, settings, owner, fireClientEvent, fireServerEvent)
 {
-	return this._javaApi.createGame
-	(
-		zone,
-		settings,
-		(owner === undefined ? null : owner),
-		(fireClientEvent === undefined ? false : fireClientEvent),
-		(fireServerEvent === undefined ? false : fireServerEvent)
-	);
+	return this._javaApi.createGame(zone, settings, owner, fireClientEvent, fireServerEvent);
 }
 
 /**
@@ -1579,14 +1487,7 @@ GameApi.prototype.sendInvitation = function(inviter, invitees, expirySeconds, in
 		throw new java.lang.IllegalArgumentException("Callback handler must implement these three methods: onAccepted, onRefused, onExpired");
 
 	var handler = Java.extend(InvitationCallback, invCallBackHandler);
-	this._javaApi.sendInvitation
-	(
-		inviter,
-		invitees,
-		expirySeconds,
-		new handler(),
-		(params === undefined ? null : params)
-	);
+	this._javaApi.sendInvitation(inviter, invitees, expirySeconds, new handler(), params);
 }
 
 /**
@@ -1645,14 +1546,7 @@ GameApi.prototype.sendInvitation = function(inviter, invitees, expirySeconds, in
  */
 GameApi.prototype.replyToInvitation = function(invitedUser, invitationId, reply, params, fireClientEvent)
 {
-	this._javaApi.replyToInvitation
-	(
-		invitedUser,
-		invitationId,
-		reply,
-		(params === undefined ? null : params),
-		(fireClientEvent === undefined ? false : fireClientEvent)
-	);
+	this._javaApi.replyToInvitation(invitedUser, invitationId, reply, params, fireClientEvent);
 }
 
 /**
@@ -1673,16 +1567,7 @@ GameApi.prototype.sendJoinRoomInvitation = function(target, inviter, invitees, e
 	if (invitees instanceof Array)
 		invitees = $$Util.toList(invitees);
 
-	this._javaApi.sendJoinRoomInvitation
-	(
-		target,
-		inviter,
-		invitees,
-		expirySeconds,
-		(asSpect === undefined ? false : asSpect),
-		(leaveLastJoinedRoom === undefined ? false : leaveLastJoinedRoom),
-		(params === undefined ? null : params)
-	);
+	this._javaApi.sendJoinRoomInvitation(target, inviter, invitees, expirySeconds, asSpect, leaveLastJoinedRoom, params);
 }
 
 //==============================================================================
@@ -1731,13 +1616,7 @@ MMOApi = function()
  */
 MMOApi.prototype.sendObjectMessage = function(targetRoom, sender, message, aoi)
 {
-	this._javaApi.sendObjectMessage
-	(
-		targetRoom,
-		sender,
-		message,
-		(aoi === undefined ? null : aoi)
-	);
+	this._javaApi.sendObjectMessage(targetRoom, sender, message, aoi);
 }
 
 /**
@@ -1755,14 +1634,7 @@ MMOApi.prototype.sendObjectMessage = function(targetRoom, sender, message, aoi)
  */
 MMOApi.prototype.sendPublicMessage = function(targetRoom, sender, message, params, aoi)
 {
-	this._javaApi.sendPublicMessage
-	(
-		targetRoom,
-		sender,
-		message,
-		(params === undefined ? null : params),
-		(aoi === undefined ? null : aoi)
-	);
+	this._javaApi.sendPublicMessage(targetRoom, sender, message, params, aoi);
 }
 
 /**
@@ -1816,12 +1688,7 @@ MMOApi.prototype.setMMOItemVariables = function(item, variables, fireClientEvent
 	if (variables instanceof Array)
 		variables = $$Util.toList(variables);
 
-	this._javaApi.setMMOItemVariables
-	(
-		item,
-		variables,
-		(fireClientEvent === undefined ? false : fireClientEvent)
-	);
+	this._javaApi.setMMOItemVariables(item, variables, fireClientEvent);
 }
 
 //--- MMOApi helper object -----------------------------------------------------