GetBanTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will return the banning time of the specified [[ban]] pointer.
This function will return the banning time of the specified [[ban]] pointer in '''seconds'''.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getBanTime ( ban theBan )
int getBanTime ( ban theBan )
</syntaxhighlight>
</syntaxhighlight>


Line 12: Line 12:


===Returns===
===Returns===
* Returns a string of the banning time in the format of '''HH:MM:SS''' (Hours, minutes, seconds correspondingly)
* 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]].
* Returns '''false''' if invalid arguments are specified if there was no banning time specified for the [[ban]].



Revision as of 21:10, 13 February 2009

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

--TODO

See Also