SmartFoxServer Documentation

_server.logoutUser()

Availability:

SmartFoxServer PRO 1.5.5

Usage:

_server.logoutUser(user, fireClientEvent, fireInternalEvent)

Description:

Logout a user from the current Zone.
The client will still be connected to the server but he will have to login again in a Zone, in order to interact with the server.

Properties:

user		can be either the user id (number) or the User object (it.gotoandplay.smartfoxserver.data.User)
fireClientEvent		flag, by default = true. It fires the onLogout event on the client side
fireInternalEvent		flag, by default = true. It fires the logOut internal server event

Returns:

Nothing

Example:

/*
* The server extension receives a custom request from the client
* and logs out the user.
*
* Additional flags are not passed, so default values will be used
*/
function handleRequest(cmd, params, user, fromRoom)
{
	if (cmd == "letMeOut")
	{
		trace("User " + user.getName() + " wants to go out!")
		_server.logoutUser(user)
	}
}