KickPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Server function}}
__NOTOC__
This function will kick the specified player from the server.
This function will kick the specified player from the server.


Line 12: Line 13:
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''responsiblePlayer:''' The player that is responsible the event
*'''responsiblePlayer:''' The player that is responsible for the event
*'''reason:''' The reason the player will be kicked from the server
*'''reason:''' The reason for the kick


===Returns===
===Returns===
Line 21: Line 22:
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">
--Add the "kick" command handler
addCommandHandler ( "kick", "kickPlayer" )
function kickPlayer ( player, commandname, kickedname, reason )
function kickPlayer ( player, commandname, kickedname, reason )
--Get player element from the name
-- Get player element from the name
local kicked = getPlayerFromNick ( kickedname )
local kicked = getPlayerFromNick ( kickedname )
--If the client who sent the command has a higher level
-- If the client who sent the command has a higher level
if getClientLevel ( player ) > getClientLevel ( kicked ) then
if getClientLevel ( player ) > getClientLevel ( kicked ) then
--Kick the player
-- Kick the player
kickPlayer ( kicked, player, reason )
kickPlayer ( kicked, player, reason )
end
end
end
end
--Add the "kick" command handler
addCommandHandler ( "kick", kickPlayer )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Admin_functions}}
{{Admin_functions}}

Revision as of 19:36, 16 August 2007

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

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 kickPlayer ( player, 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 getClientLevel ( player ) > getClientLevel ( kicked ) then
		-- Kick the player
		kickPlayer ( kicked, player, reason )
	end
end
--Add the "kick" command handler
addCommandHandler ( "kick", kickPlayer )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/KickPlayer?oldid=10538"