KickPlayer: Difference between revisions

Latest revision as of 00:17, 7 March 2021

[[{{{image}}}\|link=\|]]	Note: Don't forget to give admin rights to the resource, in which you are using kickPlayer function or it won't work.

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 )

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
+{{note| Don't forget to give admin rights to the resource, in which you are using kickPlayer function or it won't work.}}
-__NOTOC__
+{{Server function}}
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+__NOTOC__
+This function will kick the specified player from the server.
 ==Syntax==
 <syntaxhighlight lang="lua">
-Insert syntax here
+bool kickPlayer ( player kickedPlayer, [ player/string responsiblePlayer, string reason = "" ] )
 </syntaxhighlight>
+''or''
+<syntaxhighlight lang="lua">
+bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )
+</syntaxhighlight>
+{{OOP||[[player]]:kick||}}
 ===Required Arguments===
-*'''argumentName:''' description
+*'''kickedPlayer:''' The player that will be kicked from the server
 ===Optional Arguments===
-{{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" (Maximum 30 characters if using a string).
-*'''argumentName2:''' descriptiona
+*'''reason:''' The reason for the kick. (Maximum 64 characters before 1.5.8, Maximum 128 characters after 1.5.8)
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns ''true'' if the player was kicked succesfully, ''false'' if invalid arguments are specified.
 ==Example==
-This example does...
+This example lets a player kick anyone who has a lower level.
 <syntaxhighlight lang="lua">
---This line does...
+function kickPlayerHandler ( sourcePlayer, commandname, kickedname, ... )
-blabhalbalhb --abababa
+	-- Get player element from the name
---This line does this...
+	local kicked = getPlayerFromName ( kickedname )
-mooo
+	-- 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 )
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Admin_functions}}
+[[es:kickPlayer]]
+[[ru:kickPlayer]]