WoW:API date: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API date to API date without leaving a redirect)
 
(8 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<tt>date ([format [, time]])</tt>
{{wowlua}}
date() is a reference to the os.date function. It is put in the global table as the os module is not available.
date ([format [, time]])


It returns a string or a table containing the user's machine's current date and time (or the time represented by <tt>time</tt>), formatted according to the given string <tt>format</tt>.  If one wishes to supply your own format string, then it uses the same rules as [http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html strftime()].  The special string <tt>*t</tt> tells the <tt>date()</tt> function to return a table.


This is a mirror of the LUA function [http://www.lua.org/manual/5.0/manual.html#5.7 os.date()].
It returns a string or a table containing the user's machine's current date and time (or the [[API_time|time]] represented by <tt>time</tt>), formatted according to the given string <tt>format</tt>. If one wishes to supply your own format string, then it uses the same rules as [http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html strftime()]. The special string <tt>
*t</tt> tells the <tt>date()</tt> function to return a table.


If one supplies no arguments, it returns the current date and time formatted using the following string: <tt>%m/%d/%y %H:%M:%S</tt>
This is a mirror of the LUA function [http://www.lua.org/manual/5.1/manual.html#pdf-os.date os.date()].


{{Template:WoW API}}
Note that the default format returned when calling the date() function with no parameters will be different depending on whether the game is running on a PC or a Macintosh computer. If you want your addon to be compatible with both systems, you should therefore not use date() without parameters, instead, use
 
date("%m/%d/%y %H:%M:%S")
to display the date in the default PC format
 
-or-
 
date("%a %b %d %H:%M:%S %Y")
to display the date in the default Macintosh format
 
== Also see ==
* {{api|GetGameTime}}()

Latest revision as of 04:45, 15 August 2023

WoW Lua

date() is a reference to the os.date function. It is put in the global table as the os module is not available.

date ([format [, time]])


It returns a string or a table containing the user's machine's current date and time (or the time represented by time), formatted according to the given string format. If one wishes to supply your own format string, then it uses the same rules as strftime(). The special string

  • t tells the date() function to return a table.

This is a mirror of the LUA function os.date().

Note that the default format returned when calling the date() function with no parameters will be different depending on whether the game is running on a PC or a Macintosh computer. If you want your addon to be compatible with both systems, you should therefore not use date() without parameters, instead, use

date("%m/%d/%y %H:%M:%S")

to display the date in the default PC format

-or-

date("%a %b %d %H:%M:%S %Y")

to display the date in the default Macintosh format

Also see[edit]