GetBanTime: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns a ''string'' of the banning time | * Returns a ''string'' of the banning time in the format of '''HH:MM:SS''' (Hours, minutes, seconds correspondingly) | ||
* Returns ''false'' if invalid arguments are specified if there was no banning time specified for the [[ban]]. | |||
==Example== | ==Example== | ||
Revision as of 18:00, 23 January 2009
This function will return the banning time of the specified ban pointer.
Syntax
string getBanTime ( ban theBan )
Required Arguments
- theBan: The ban in which you wish to retrieve the time of.
Returns
- Returns a string of the banning time in the format of HH:MM:SS (Hours, minutes, seconds correspondingly)
- Returns false if invalid arguments are specified if there was no banning time 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