KickPlayer: Difference between revisions
Jump to navigation
Jump to search
(removed the note about optional parameters, as this is exactly wrong for kickPlayer) |
mNo edit summary |
||
| (7 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{note| Don't forget to give admin rights to the resource, in which you are using kickPlayer function or it won't work.}} | |||
{{Server function}} | {{Server function}} | ||
__NOTOC__ | __NOTOC__ | ||
| Line 5: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] ) | bool kickPlayer ( player kickedPlayer, [ player/string responsiblePlayer, string reason = "" ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
''or'' | ''or'' | ||
| Line 11: | Line 13: | ||
bool kickPlayer ( player kickedPlayer, [ string reason = "" ] ) | bool kickPlayer ( player kickedPlayer, [ string reason = "" ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[player]]:kick||}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''kickedPlayer:''' The player that will be kicked from the server | *'''kickedPlayer:''' The player that will be kicked from the server | ||
| Line 17: | Line 19: | ||
===Optional Arguments=== | ===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" (Maximum 30 characters if using a string). | *'''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" (Maximum 30 characters if using a string). | ||
*'''reason:''' The reason for the kick. | *'''reason:''' The reason for the kick. (Maximum 64 characters before 1.5.8, Maximum 128 characters after 1.5.8) | ||
===Returns=== | ===Returns=== | ||
| Line 25: | Line 27: | ||
This example lets a player kick anyone who has a lower level. | This example lets a player kick anyone who has a lower level. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function kickPlayerHandler ( sourcePlayer, commandname, kickedname, | function kickPlayerHandler ( sourcePlayer, commandname, kickedname, ... ) | ||
-- Get player element from the name | -- Get player element from the name | ||
local kicked = getPlayerFromName ( kickedname ) | local kicked = getPlayerFromName ( kickedname ) | ||
-- If the client who sent the command has a higher level | -- If the client who sent the command has a higher level | ||
local reason = table.concat({...}, " ") | |||
if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then | if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then | ||
-- Kick the player | -- Kick the player | ||
Latest revision as of 00:17, 7 March 2021
This function will kick the specified player from the server.
Syntax
bool kickPlayer ( player kickedPlayer, [ player/string responsiblePlayer, string reason = "" ] )
or
bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )
OOP Syntax Help! I don't understand this!
- Method: player:kick(...)
Required Arguments
- kickedPlayer: The player that will be kicked from the server
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" (Maximum 30 characters if using a string).
- reason: The reason for the kick. (Maximum 64 characters before 1.5.8, Maximum 128 characters after 1.5.8)
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, ... )
-- Get player element from the name
local kicked = getPlayerFromName ( kickedname )
-- If the client who sent the command has a higher level
local reason = table.concat({...}, " ")
if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
-- Kick the player
kickPlayer ( kicked, sourcePlayer, reason )
end
end
-- Add the "kick" command handler
addCommandHandler ( "kick", kickPlayerHandler )