Timestamp Class - Revision history

Elverion at 01:24, 29 June 2016

2016-06-29T01:24:04Z

Elverion: /* The Timestamp class is an optional library */

2015-10-13T22:08:22Z

‎The Timestamp class is an optional library

Elverion at 22:06, 13 October 2015

2015-10-13T22:06:39Z

Elverion: Created page with " = The Timestamp class is an optional library = In order to use this class, you must require it in one of your source files (preferably main.lua) prior to use. It only needs t..."

2015-10-13T21:08:19Z

Created page with " = The Timestamp class is an optional library = In order to use this class, you must require it in one of your source files (preferably main.lua) prior to use. It only needs t..."

New page

= The Timestamp class is an optional library =
In order to use this class, you must require it in one of your source files (preferably main.lua) prior to use. It only needs to be required once in a single file. It is recommended you do this at the top of your file, outside of any functions or other code, and you may do this by using this code:
<source lang="lua">
require('timestamp');
</source>

= Method Chaining Support =
The Timestamp class supports method chaining, but '''does not''' modify the base object unless explicitly stated. That is, most functions will return a new Timestamp object with the modification made. For example:
<source lang="lua">
t = Timestamp:now(); -- Assign 'now' to 't'

-- Assigning a value to a timestamp
t:addSeconds(5); -- Invalid; 't' will not be modified!
t = t:addSeconds(5); -- Valid; 't' now contains 'now' + 5 seconds.

-- Method chaining
t = Timestamp:now():addSeconds(5); -- Also valid; 't' contains 'now' + 5 seconds.
</source>

= Supported Methods =
== Constructor ==
'''class Timestamp(number year, number month, number day, number hour, number minutes, number seconds)'''

'''class Timestamp(number unixTime)'''

'''class Timestamp()'''

Creates a Timestamp object out of an arbitrarily defined date and time. Any field that is nil should be assumed from the current time. That is, leaving 'year' as nil will assume the real, current year pulled from your computer's clock, while any given fields will be filled with the information you have provided.

You may also pass a [https://en.wikipedia.org/wiki/Unix_time UNIX timestamp].

== Timestamp:now ==
'''class Timestamp:now()'''

Returns a Timestamp object that contains the current date/time value of your computer's clock.

== Timestamp:today ==
'''class Timestamp:today()'''

Returns a Timestamp object that contains the current date with time starting at 12:00AM.

== Timestamp:yesterday ==
'''class Timestamp:yesterday'''

Exactly like Timestamp:today() except it is for yesterday's date/time.

== Timestamp:tomorrow ==
'''class Timestamp:tomorrow'''

Exactly like Timestamp:today() except it is for tomorrow's date/time.

← Older revision		Revision as of 01:24, 29 June 2016
Line 61:		Line 61:

	Exactly like Timestamp:today() except it is for tomorrow's date/time.		Exactly like Timestamp:today() except it is for tomorrow's date/time.
		+
		+
		+	== Timestamp:timezoneOffset ==
		+	'''number Timestamp:timezoneOffset()'''
		+
		+	Returns your offset, in hours, from UTC


Line 70:		Line 76:
	Returns the timestamp as a human-readable string and (optionally) including tz_offset to represent the timezone's offset from the prime meridian. If tz_offset is not given, the time will be using local time. tz_ofset = 0 will return time in UTC.		Returns the timestamp as a human-readable string and (optionally) including tz_offset to represent the timezone's offset from the prime meridian. If tz_offset is not given, the time will be using local time. tz_ofset = 0 will return time in UTC.

		+
		+	== Timestamp:toUtc ==
		+	'''string Timestamp:toUtc()''''
		+
		+	'''string Timestamp:toUtc()'''
		+
		+	Returns the timestamp as a human-readable string in UTC format. For example: Thu, 01 Jan 1970 00:00:00 UTC

@@ Line 1: / Line 1: @@
-= The Timestamp class is an optional library =
+= Loading the Timestamp Class =
-In order to use this class, you must require it in one of your source files (preferably main.lua) prior to use. It only needs to be required once in a single file. It is recommended you do this at the top of your file, outside of any functions or other code, and you may do this by using this code:
+The Timestamp class is an optional library. In order to use this class, you must require it in one of your source files (preferably main.lua) prior to use. It only needs to be required once in a single file. It is recommended you do this at the top of your file, outside of any functions or other code, and you may do this by using this code:
 <source lang="lua">
 require('timestamp');
 </source>
 = Method Chaining Support =

@@ Line 18: / Line 18: @@
 -- Method chaining
 t = Timestamp:now():addSeconds(5);  -- Also valid; 't' contains 'now' + 5 seconds.
 </source>
-= Supported Methods =
+= Supported Operators =
 == Constructor ==
 '''class Timestamp(number year, number month, number day, number hour, number minutes, number seconds)'''
@@ Line 47: / Line 53: @@
 == Timestamp:yesterday ==
-'''class Timestamp:yesterday'''
+'''class Timestamp:yesterday()'''
 Exactly like Timestamp:today() except it is for yesterday's date/time.
@@ Line 53: / Line 59: @@
 == Timestamp:tomorrow ==
-'''class Timestamp:tomorrow'''
+'''class Timestamp:tomorrow()'''
 Exactly like Timestamp:today() except it is for tomorrow's date/time.