AddBan: Difference between revisions
Jump to navigation
Jump to search
(Added updated ban syntax for time based bans.) |
(Admin rights required.) |
||
| (20 intermediate revisions by 13 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function will add a ban for the specified IP/username/serial to the server. | This function will add a [[ban]] for the specified IP/username/serial to the server. | ||
{{Note|One of the three: IP, Username or Serial have to be specified.}} | |||
{{note| Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.}} | |||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 9: | ||
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] ) | ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Ban]]}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''. | *'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''. | ||
*'''Username:''' The username to be banned. If you don't want to ban by username, set this to ''nil''. | '''or''' | ||
*'''Username:''' The [http://community.mtasa.com/ 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''. | *'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''. | ||
''' or any combination.''' | |||
===Optional Arguments=== | ===Optional Arguments=== | ||
| Line 21: | Line 27: | ||
===Returns=== | ===Returns=== | ||
Returns | Returns the new [[ban]] if the IP/username/serial was banned successfully, ''false'' if invalid arguments are specified. | ||
==Example== | ==Example== | ||
This example bans a player's IP with the reason "Requested" when they type "/ban-me". | |||
<syntaxhighlight lang="lua"> | |||
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" | |||
</syntaxhighlight> | |||
==Example 2== | |||
This example add command to ban player serial. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
- | 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 ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Admin functions}} | {{Admin functions}} | ||
[[ru:addBan]] | |||
Latest revision as of 17:08, 6 December 2023
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 ] )
OOP Syntax Help! I don't understand this!
- Method: Ban(...)
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 the new ban if the IP/username/serial was banned successfully, 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 )