GetBanTime: Difference between revisions
Jump to navigation
Jump to search
Enterprise (talk | contribs) No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function retrieveBan(theBan) | |||
local ban = getBanTime(theBan) | |||
if ban then | |||
outputChatBox("The following ban duration is: "..ban, getRootElement(), 255,255,255, true) | |||
end | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 20:13, 2 May 2011
This function will return the banning time of the specified ban pointer in seconds.
Syntax
int getBanTime ( ban theBan )
Required Arguments
- theBan: The ban in 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 are specified if there was no banning time specified for the ban.
Example
function retrieveBan(theBan)
local ban = getBanTime(theBan)
if ban then
outputChatBox("The following ban duration is: "..ban, getRootElement(), 255,255,255, true)
end
end