AR/addBan: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 52: | Line 52: | ||
==See Also== | ==See Also== | ||
{{AR Admin functions}} | {{AR/Admin functions}} | ||
[[en:addBan]] | [[en:addBan]] |
Revision as of 19:38, 1 September 2012
This function will add a ban for the specified IP/username/serial to the server.
Syntax
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )
Note: One of the three: IP, Username or Serial have to be specified.
Required Arguments
- IP: The IP to be banned. If you don't want to ban by IP, set this to nil.
or
- Username: The MTA Community username to be banned (now obsolete). If you don't want to ban by username, set this to nil.
or
- Serial: The serial to be banned. If you don't want to ban by serial, set this to nil.
or any combination.
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.
- responsibleElement: The element that is responsible for banning the IP/username/serial. This can be a player or the root (getRootElement()).
- reason: The reason the IP/username/serial will be banned from the server.
- seconds: The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.
Returns
Returns true if the IP/username/serial was banned succesfully, false if invalid arguments are specified.
Example
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
function banMe ( source, command ) -- The function header and where source is defined local ipToBan = getPlayerIP ( source ) -- Get the player's IP addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested end addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
Example 2
This example add command to ban player serial.
function banSerial( source, command, noob, reason ) if ( noob ) then local theNoob = getPlayerFromName( noob ) if ( theNoob ) then local theNoobSerial = getPlayerSerial( theNoob ) addBan( nil, nil, theNoobSerial, source, reason ) end end end addCommandHandler( "ban-serial", banSerial )