_server.kickUser()
Availability:
SmartFoxServer PRO 1.6.3
Usage:
_server.kickUser(user, delay, farewellMessage)
Description:
Kicks a user off the server after a certain amount of seconds. The farewellMessage allows you to immediately send an Administrator Message to the user being kicked. On the client side the message should be handled via the onAdministratorMessage callback.
Properties:
| user | the user to kick | |
| delay | the amount of delay (in seconds) before the action is performed | |
| farewellMessage | an Administrator Message that is delivered immediately to the client |
Returns:
nothing.
Example:
/* * Kicks a user (it.gotoandaply.smartfoxserver.data.User) referenced by the kickableUser variable * The action is delayed by 15 seconds */ _server.kickUser(kickableUser, 15, "You are being disconnected in 15 seconds!")
See also:
banUser, banOfflineUser