GetBanReason: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} This function will return the ban reason of the specified ban element. ==Syntax== <syntaxhighlight lang="lua"> string getBanReason ( ban theBan ) </syntaxhighlight> ===Required...) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function will return the ban reason of the specified [[ban]] | This function will return the ban reason of the specified [[ban]] pointer. | ||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBan:''' The [[ban]] | *'''theBan:''' The [[ban]] in which you want to return the reason of. | ||
===Returns=== | ===Returns=== | ||
Returns a ''string'' of the reason if everything was successfull, ''false'' if invalid arguments are specified if there was no reason specified for the [[ban]] | Returns a ''string'' of the reason if everything was successfull, ''false'' if invalid arguments are specified if there was no reason specified for the [[ban]]. | ||
==Example== | ==Example== | ||
Revision as of 17:37, 23 January 2009
This function will return the ban reason of the specified ban pointer.
Syntax
string getBanReason ( ban theBan )
Required Arguments
- theBan: The ban in which you want to return the reason of.
Returns
Returns a string of the reason if everything was successfull, false if invalid arguments are specified if there was no reason specified for the ban.
Example
--TODO
See Also
- addBan
- banPlayer
- getBanAdmin
- getBanIP
- getBanNick
- getBanReason
- getBanSerial
- getBanTime
- getBanUsername
- getBans
- getUnbanTime
- isBan
- kickPlayer
- setBanAdmin
- setBanNick
- setBanReason
- setUnbanTime
- reloadBans
- removeBan