SDateTime

Index

Functions Index

Function Name
bool Equals (SDateTime other)
int ComparesTo (SDateTime other)
string FormatLocal (string format)
string FormatGlobal (string format)
string Regional (string region)
string FormatRegional (string region, string format)
SDateTime AddYears (int amount)
SDateTime AddMonths (int amount)
SDateTime AddDays (double amount)
SDateTime AddHours (double amount)
SDateTime AddMinutes (double amount)
SDateTime AddSeconds (double amount)
SDateTime AddMilliseconds (double amount)
Static Functions
static SDateTime Now()
static SDateTime Server ()
static SDateTime Parse (string input)
static bool IsLeapYear (int year)
static int DaysInMonth (int year, int month)

Properties Index

Property Name
int Year get
int Month get
int Day get
int Hour get
int Minute get
int Second get
int Millisecond get
string Local get
string Global get
int UnixTime get
bool IsDaylightSavingTime get

Functions

Equals

bool Equals (SDateTime other)

Returns true if the datetimes are same.

Parameter	Type	Description

Lua

ATargetDateTime = DateTime.Now().AddMinutes(5)
AreEqual = ATargetDateTime.Equals(DateTime.Now())

ComparesTo

int ComparesTo (SDateTime other)

Compares two datetimes and returns an integer. 0 == identical. greater than 0 == This datetime is greater than other. less than 0 == This datetime is less than other.

Parameter	Type	Description

Lua

ATargetDateTime = DateTime.Now().AddMinutes(5)
AreEqual = ATargetDateTime.ComparesTo(DateTime.Now())

FormatLocal

string FormatLocal (string format)

Outputs a custom formatted string with the date and time according to local language rules.

Parameter	Type	Description
format	string	See below for examples

Lua

localTimeCustomFormat = DateTime.Now().FormatLocal("dddd, MMMM dd, yyyy h:mm:ss tt")

Lua

--Example format strings

--[[ 
format = "dddd, MMMM dd, yyyy h:mm:ss tt"
Result: Monday, May 28, 2012 11:35:00 AM

format = "Ldddd, MMMM dd, yyyy"
Result: Monday, May 28, 2012

 format = "h:mm:ss tt"
 Result: 11:35:00 AM

 format = "MMMM dd"
Result: May 28

 format = "ddd, dd MMM yyyy HH':'mm':'ss 'GMT"
Result: Mon, 28 May 2012 11:35:00 GMT

 format = "M/d/yyyy"
 Result: 5/28/2012

 format = "h:mm tt"
Result: 11:35 AM

format = "yyyy'-'MM'-'dd'T'HH':'mm':'ss"
Result: 2012-05-28T11:35:00

format = "yyyy'-'MM'-'dd HH':'mm':'ss'Z'"
 Result: 2012-05-28 11:35:00Z

format = "MMMM, yyyy"
 Result: May, 2012
    --]]

FunctionName

string FormatGlobal (string format)

Outputs a custom formatted string with the date and time according to global rules (culture invariant).

Parameter	Type	Description

Lua

GlobalTimeCustomFormat = DateTime.Now().FormatLocal("dddd, MMMM dd, yyyy h:mm:ss tt")

Lua

--Example format strings

--[[ 
format = "dddd, MMMM dd, yyyy h:mm:ss tt"
Result: Monday, May 28, 2012 11:35:00 AM

format = "Ldddd, MMMM dd, yyyy"
Result: Monday, May 28, 2012

 format = "h:mm:ss tt"
 Result: 11:35:00 AM

 format = "MMMM dd"
Result: May 28

 format = "ddd, dd MMM yyyy HH':'mm':'ss 'GMT"
Result: Mon, 28 May 2012 11:35:00 GMT

 format = "M/d/yyyy"
 Result: 5/28/2012

 format = "h:mm tt"
Result: 11:35 AM

format = "yyyy'-'MM'-'dd'T'HH':'mm':'ss"
Result: 2012-05-28T11:35:00

format = "yyyy'-'MM'-'dd HH':'mm':'ss'Z'"
 Result: 2012-05-28 11:35:00Z

format = "MMMM, yyyy"
 Result: May, 2012
    --]]

Regional

string Regional (string region)

Outputs a string with the date and time formatted according to specific regional rules.

Parameter	Type	Description
region	string	List available here

Lua

stringTimeRegional = DateTime.Now().Regional('en-us')

FormatRegional

string FormatRegional (string region, string format)

Outputs a custom formatted string with the date and time according to specific regional rules.

Parameter	Type	Description
region	string	List available here
format	string	See below

Lua

stringTimeFormatRegional = DateTime.Now().FormatRegional('en-us','dddd, MMMM dd, yyyy h:mm:ss tt')

Lua

--Example format strings

--[[ 
format = "dddd, MMMM dd, yyyy h:mm:ss tt"
Result: Monday, May 28, 2012 11:35:00 AM

format = "Ldddd, MMMM dd, yyyy"
Result: Monday, May 28, 2012

 format = "h:mm:ss tt"
 Result: 11:35:00 AM

 format = "MMMM dd"
Result: May 28

 format = "ddd, dd MMM yyyy HH':'mm':'ss 'GMT"
Result: Mon, 28 May 2012 11:35:00 GMT

 format = "M/d/yyyy"
 Result: 5/28/2012

 format = "h:mm tt"
Result: 11:35 AM

format = "yyyy'-'MM'-'dd'T'HH':'mm':'ss"
Result: 2012-05-28T11:35:00

format = "yyyy'-'MM'-'dd HH':'mm':'ss'Z'"
 Result: 2012-05-28 11:35:00Z

format = "MMMM, yyyy"
 Result: May, 2012
    --]]

AddYears

SDateTime AddYears (int amount)

Return a new SDateTime that is the current date time + amount years.

Parameter	Type	Description

Lua

date5YearsLater = DateTime.Now().AddYears(5)

AddMonths

SDateTime AddMonths (int amount)

Return a new SDateTime that is the current date time + amount months.

Parameter	Type	Description

Lua

date5MonthsLater = DateTime.Now().AddMonths(5)

AddDays

SDateTime AddDays (double amount)

Return a new SDateTime that is the current date time + amount days.

Parameter	Type	Description

Lua

date5DaysLater = DateTime.Now().AddDays(5)

AddHours

SDateTime AddHours (double amount)

Return a new SDateTime that is the current date time + amount hours.

Parameter	Type	Description

Lua

date5HoursLater = DateTime.Now().AddHours(5)

AddMinutes

SDateTime AddMinutes (double amount)

Return a new SDateTime that is the current date time + amount minutes.

Parameter	Type	Description

Lua

date5MinutesLater = DateTime.Now().AddMinutes(5)

AddSeconds

SDateTime AddSeconds (double amount)

Return a new SDateTime that is the current date time + amount seconds.

Parameter	Type	Description

Lua

date5SecondsLater = DateTime.Now().AddSeconds(5)

AddMilliseconds

SDateTime AddMilliseconds (double amount)

Return a new SDateTime that is the current date time + amount milliseconds.

Parameter	Type	Description

Lua

date5MillisecondsLater = DateTime.Now().AddMilliseconds(5)

Now

static SDateTime Now()

Creates a new SDateTime object equal to the current local time.

Parameter	Type	Description

Lua

localDateTime = DateTime.Now()

Server

static SDateTime Server ()

Creates a new SDateTime object equal to the current server time.

Parameter	Type	Description

Lua

serverDateTime = DateTime.Server()

Parse

static SDateTime Parse (string input)

Creates a new SDateTime object by attempting to parse a string input. Returns null/nil if the string cannot be parsed.

Parameter	Type	Description

Lua

parseDateTime = DateTime.Parse('10/3/2022 1:26:02 PM')

IsLeapYear

static bool IsLeapYear (int year)

Return true if the specified year is a leap year.

Parameter	Type	Description

Lua

isLeapYear = DateTime.IsLeapYear(2024)

DaysInMonth

static int DaysInMonth (int year, int month)

Return the number of days in the given month for the given year.

Parameter	Type	Description

Lua

isLeapYear = DateTime.DaysInMonth(2022, 8)

Properties

Year

int Year get

Get the independent time unit property of the SDateTime object.

Lua

currentYear = DateTime.Now().Year

Month

int Month get

Property Description

Lua

currentMonth = DateTime.Now().Month

Day

int Day get

Property Description

Lua

currentDay = DateTime.Now().Day

Hour

int Hour get

Property Description

Lua

currentHour = DateTime.Now().Hour

Minute

int Minute get

Property Description

Lua

currentMinute = DateTime.Now().Minute

Second

int Second get

Property Description

Lua

currentSecond = DateTime.Now().Second

Millisecond

int Millisecond get

Property Description

Lua

currentMillisecond = DateTime.Now().Millisecond

Local

string Local get

Outputs a string with the date and time formatted according to local language rules.

Lua

currentTimeStringLocal = DateTime.Now().Local

Global

string Global get

Outputs a string with the date and time formatted according to global rules (culture invariant).

Lua

currentTimeStringGlobal = DateTime.Now().Global

UnixTime

int UnixTime get

Return this time in Unix time, the number of seconds since Jan 1st, 1970.

Lua

currentUnixTime = DateTime.Now().UnixTime

IsDaylightSavingTime

bool IsDaylightSavingTime get

Indicates whether this instance of DateTime is within the daylight saving time range for the current time zone.

Lua

isCurrentTimeDaylightSaving = DateTime.Now().IsDaylightSavingTime