AR/kickPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server function}} __NOTOC__ This function will kick the specified player from the server. ==Syntax== <syntaxhighlight lang="lua"> bool kickPlayer ( player kickedPlayer, [ player responsible...")
 
Line 40: Line 40:


==See Also==
==See Also==
{{Admin_functions}}
{{AR/Admin_functions}}
[[es:kickPlayer]]
[[es:kickPlayer]]
[[ru:kickPlayer]]
[[ru:kickPlayer]]

Revision as of 16:45, 1 September 2012

This function will kick the specified player from the server.

Syntax

bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )         

or

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" (Maximum 30 characters if using a string).
  • 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 = getPlayerFromName ( 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 )

See Also