KickPlayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 13: | Line 13: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''responsiblePlayer:''' The player that is responsible for the event. This argument can also be used as | *'''responsiblePlayer:''' The player that is responsible for the event | ||
*'''reason:''' The reason for the kick. This argument can also be used as the 2nd argument, in this case responsible player for the kick is "Console". | |||
===Returns=== | ===Returns=== | ||
Revision as of 15:48, 7 August 2009
This function will kick the specified player from the server.
Syntax
bool kickPlayer ( player kickedPlayer , [ player responsiblePlayer , 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
- reason: The reason for the kick. This argument can also be used as the 2nd argument, in this case responsible player for the kick is "Console".
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 )