GetBanTime: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} This function will return the banning time of the specified ban element. ==Syntax== <syntaxhighlight lang="lua"> string getBanTime ( ban theBan ) </syntaxhighlight> ===Required...) |
(Added oop syntax) |
||
| (12 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function will return the | This function will return the time the specified [[ban]] was created, in '''seconds'''. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getBanTime ( ban theBan ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[ban]]:getTime|time}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBan:''' The [[ban]] | *'''theBan:''' The [[ban]] of which you wish to retrieve the time of. | ||
===Returns=== | ===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 '''false''' if invalid arguments were specified or if there was no banning time specified for the [[ban]]. | |||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
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 | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Admin functions}} | {{Admin functions}} | ||
[[ru:getBanTime]] | |||
Latest revision as of 15:36, 6 August 2016
This function will return the time the specified ban was created, in seconds.
Syntax
int getBanTime ( ban theBan )
OOP Syntax Help! I don't understand this!
- Method: ban:getTime(...)
- Variable: .time
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