Difference between revisions of "GetBanTime"

From Multi Theft Auto: Wiki
(Learn to indent and create examples that actually use a function correctly.)
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Server function}}
 
{{Server function}}
This function will return the banning time of the specified [[ban]] pointer in '''seconds'''.
+
This function will return the time the specified [[ban]] was created, in '''seconds'''.
  
 
==Syntax==  
 
==Syntax==  

Revision as of 10:13, 3 May 2011

This function will return the time the specified ban was created, 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 time of ban is: "..ban, getRootElement(), 255,255,255, true)
    end
end

See Also