BanPlayer

This function will ban the specified player from the server.

Syntax

bool banPlayer ( player bannedPlayer , [ player responsiblePlayer , string reason ] )         

Required Arguments

• bannedPlayer: The player that will be banned 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 banning the player
• reason: The reason the player will be banned from the server

Returns

Returns true if the player was banned succesfully, false if invalid arguments are specified.

Example

This example lets a player ban anyone who has a lower level.

--Add the "ban" command handler
function banPlayer ( thePlayer, commandname, bannedname, reason )
	--Get player element from the name
	local banned = getPlayerFromNick ( bannedname )
	--If the client who sent the command has a higher level
	if getClientLevel ( thePlayer ) > getClientLevel ( banned ) then
		--Ban the player
		banPlayer ( banned, thePlayer, reason )
	end
end
addCommandHandler ( "ban", banPlayer )

See Also

• addBan
• banPlayer
• getBanAdmin
• getBanIP
• getBanNick
• getBanReason
• getBanSerial
• getBanTime
• getBanUsername
• getBans
• getUnbanTime
• isBan
• kickPlayer
• setBanAdmin
• setBanNick
• setBanReason
• setUnbanTime
• reloadBans
• removeBan