RemoveBan: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} This function will remove a ban specified by the ban element. ==Syntax== <syntaxhighlight lang="lua"> bool removeBan ( ban theBan, [ player responsibleElement ] ) </c...) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function will remove a ban specified by the [[ban]] | This function will remove a ban specified by the [[ban]] pointer. | ||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBan:''' The [[ban]] | *'''theBan:''' The [[ban]] to be removed. | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
Revision as of 17:39, 23 January 2009
This function will remove a ban specified by the ban pointer.
Syntax
bool removeBan ( ban theBan, [ player responsibleElement ] )
Required Arguments
- theBan: The ban to be removed.
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 removing the ban element. This can be a player or the root (getRootElement()).
Returns
Returns true if the ban was removed 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