GetBanTime: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBan:''' The [[ban]] | *'''theBan:''' The [[ban]] of which you wish to retrieve the time of. | ||
===Returns=== | ===Returns=== | ||
* Returns an integer of the banning time in the format of seconds from the year 1970. Use in conjunction with [[getRealTime]] in order to retrieve detailed information. | * Returns an integer of the banning time in the format of seconds from the year 1970. Use in conjunction with [[getRealTime]] in order to retrieve detailed information. | ||
* Returns '''false''' if invalid arguments | * Returns '''false''' if invalid arguments were specified or if there was no banning time specified for the [[ban]]. | ||
==Example== | ==Example== | ||
Revision as of 13:25, 24 November 2015
This function will return the time the specified ban was created, in seconds.
Syntax
int getBanTime ( ban theBan )
Required Arguments
- theBan: The ban of which you wish to retrieve the time of.
Returns
- Returns an integer of the banning time in the format of seconds from the year 1970. Use in conjunction with getRealTime in order to retrieve detailed information.
- Returns false if invalid arguments were specified or if there was no banning time specified for the ban.
Example
function retrieveBan(theBan)
local ban = getBanTime(theBan)
if ban then
outputChatBox("The time of the ban is: " .. ban, root, 255, 255, 255, false)
end
end