AddBan: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} This function will add a ban for the specified IP/username/serial to the server. ==Syntax== <syntaxhighlight lang="lua"> bool addBan ( string IP, string Username, string ...) |
mNo edit summary |
||
| Line 19: | Line 19: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the | Returns ''true'' if the IP/username/serial was banned succesfully, ''false'' if invalid arguments are specified. | ||
==Example== | ==Example== | ||
Revision as of 19:10, 22 January 2009
This function will add a ban for the specified IP/username/serial to the server.
Syntax
bool addBan ( string IP, string Username, string Serial, [ player responsibleElement, string reason ] )
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.
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