Difference between revisions of "KickPlayer"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(2nd argument can be "reason")
Line 13: Line 13:
 
===Optional Arguments===  
 
===Optional Arguments===  
 
{{OptionalArg}}  
 
{{OptionalArg}}  
*'''responsiblePlayer:''' The player that is responsible for the event
+
*'''responsiblePlayer:''' The player that is responsible for the event. This argument can also be used as reason why player was kicked, in this case '''reason''' argument is ignored and this one is used instead.
 
*'''reason:''' The reason for the kick
 
*'''reason:''' The reason for the kick
  

Revision as of 15:42, 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. This argument can also be used as reason why player was kicked, in this case reason argument is ignored and this one is used instead.
  • 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 = 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 )

See Also