KickPlayer: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool kickPlayer ( player kickedPlayer [ | bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang="lua"> | |||
bool kickPlayer ( player kickedPlayer, [ string reason = "" ] ) | |||
</syntaxhighlight> | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 14: | Line 17: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''responsiblePlayer:''' The player that is responsible for the event | *'''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. | |||
===Returns=== | ===Returns=== | ||
Revision as of 14:35, 22 December 2009
This function will kick the specified player from the server.
Syntax
bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )
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.
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 )