KickPlayer: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
(→Optional Arguments: max length of reason) |
||
| Line 18: | Line 18: | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''responsiblePlayer:''' The player that is responsible for the event. '''Note''': If left out as in the second syntax, responsible player for the kick will be "Console". | *'''responsiblePlayer:''' The player that is responsible for the event. '''Note''': If left out as in the second syntax, responsible player for the kick will be "Console". | ||
*'''reason:''' The reason for the kick. | *'''reason:''' The reason for the kick. The maximum length for this is 64 characters. | ||
===Returns=== | ===Returns=== | ||
Revision as of 00:37, 28 December 2009
This function will kick the specified player from the server.
Syntax
bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )
or
bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )
Required Arguments
- kickedPlayer: The player that will be kicked from the server
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- responsiblePlayer: The player that is responsible for the event. Note: If left out as in the second syntax, responsible player for the kick will be "Console".
- reason: The reason for the kick. The maximum length for this is 64 characters.
Returns
Returns true if the player was kicked succesfully, false if invalid arguments are specified.
Example
This example lets a player kick anyone who has a lower level.
function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason ) -- Get player element from the name local kicked = getPlayerFromNick ( kickedname ) -- If the client who sent the command has a higher level if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then -- Kick the player kickPlayer ( kicked, sourcePlayer, reason ) end end -- Add the "kick" command handler addCommandHandler ( "kick", kickPlayerHandler )