AddBan: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Added updated ban syntax for time based bans.) |
||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason ] ) | ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Note:''' One of the three: IP, Username or Serial have to be specified. | '''Note:''' One of the three: IP, Username or Serial have to be specified. | ||
Line 18: | Line 18: | ||
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()). | *'''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. | *'''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=== |
Revision as of 11:44, 26 February 2009
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.
- Username: The username to be banned. If you don't want to ban by username, set this to nil.
- Serial: The serial to be banned. If you don't want to ban by serial, set this to nil.
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
--TODO
See Also
- addBan
- banPlayer
- getBanAdmin
- getBanIP
- getBanNick
- getBanReason
- getBanSerial
- getBanTime
- getBanUsername
- getBans
- getUnbanTime
- isBan
- kickPlayer
- setBanAdmin
- setBanNick
- setBanReason
- setUnbanTime
- reloadBans
- removeBan