BanPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(fixed example syntax error)
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will ban the specified player from the server.
This function will ban the specified player from the server by IP.


==Syntax==  
==Syntax==  

Revision as of 10:42, 13 March 2008

This function will ban the specified player from the server by IP.

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 if he has ACL rights.

--Add the "ban" command handler
function banPlayerCommand ( theClient, commandName, bannedName, reason )

	-- Give the player a nice error if he doesn't have rights
	if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
		--Get player element from the name
		local bannedPlayer = getPlayerFromNick ( bannedName )

		--Ban the player
		banPlayer ( bannedPlayer, theClient, reason )
		outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

	else
		outputChatBox ( "ban: You don't have enough permissions", theClient )
	end

end
addCommandHandler ( "ban", banPlayerCommand )

See Also