DateTime Script API Type

Ben Tiedt — Tue, 26 Aug 2025 17:03:01 GMT

Current Revision posted to API Documentation by Ben Tiedt on 08/26/2025 17:03:01

Properties

Name	Access	Type	Description
Date	Read	`[[DateTime Script API Type\|DateTime]]`	Date
Day	Read	`[[Number Script API Type\|Number]]`	Day
DayOfYear	Read	`[[Number Script API Type\|Number]]`	Day Of Year
Hour	Read	`[[Number Script API Type\|Number]]`	Hour
Microsecond	Read	`[[Number Script API Type\|Number]]`	Microsecond
Millisecond	Read	`[[Number Script API Type\|Number]]`	Millisecond
Minute	Read	`[[Number Script API Type\|Number]]`	Minute
Month	Read	`[[Number Script API Type\|Number]]`	Month
Nanosecond	Read	`[[Number Script API Type\|Number]]`	Nanosecond
Second	Read	`[[Number Script API Type\|Number]]`	Second
Ticks	Read	`[[Number Script API Type\|Number]]`	Ticks
Year	Read	`[[Number Script API Type\|Number]]`	Year

Methods

AddDays

Velocity

#set($dateTimeResponse = $dateTime.AddDays($value))

JavaScript

var dateTimeResponse = dateTime.AddDays(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddHours

Velocity

#set($dateTimeResponse = $dateTime.AddHours($value))

JavaScript

var dateTimeResponse = dateTime.AddHours(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddMicroseconds

Velocity

#set($dateTimeResponse = $dateTime.AddMicroseconds($value))

JavaScript

var dateTimeResponse = dateTime.AddMicroseconds(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddMilliseconds

Velocity

#set($dateTimeResponse = $dateTime.AddMilliseconds($value))

JavaScript

var dateTimeResponse = dateTime.AddMilliseconds(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddMinutes

Velocity

#set($dateTimeResponse = $dateTime.AddMinutes($value))

JavaScript

var dateTimeResponse = dateTime.AddMinutes(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddMonths

Velocity

#set($dateTimeResponse = $dateTime.AddMonths($months))

JavaScript

var dateTimeResponse = dateTime.AddMonths(months);

Parameters

Name	Type	Description	Required	Default	Options
months	`[[Number Script API Type\|Number]]`	Months	Required

Returns

[[DateTime Script API Type|DateTime]]

AddSeconds

Velocity

#set($dateTimeResponse = $dateTime.AddSeconds($value))

JavaScript

var dateTimeResponse = dateTime.AddSeconds(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddTicks

Velocity

#set($dateTimeResponse = $dateTime.AddTicks($value))

JavaScript

var dateTimeResponse = dateTime.AddTicks(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

AddYears

Velocity

#set($dateTimeResponse = $dateTime.AddYears($value))

JavaScript

var dateTimeResponse = dateTime.AddYears(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[Number Script API Type\|Number]]`	Value	Required

Returns

[[DateTime Script API Type|DateTime]]

CompareTo

Velocity

#set($numberResponse = $dateTime.CompareTo($value))

JavaScript

var numberResponse = dateTime.CompareTo(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[DateTime Script API Type\|DateTime]]`	Value	Required

Returns

[[Number Script API Type|Number]]

IsDaylightSavingTime

Velocity

#set($booleanResponse = $dateTime.IsDaylightSavingTime())

JavaScript

var booleanResponse = dateTime.IsDaylightSavingTime();

Returns

[[Boolean Script API Type|Boolean]]

ToBinary

Velocity

#set($numberResponse = $dateTime.ToBinary())

JavaScript

var numberResponse = dateTime.ToBinary();

Returns

[[Number Script API Type|Number]]

ToFileTime

Velocity

#set($numberResponse = $dateTime.ToFileTime())

JavaScript

var numberResponse = dateTime.ToFileTime();

Returns

[[Number Script API Type|Number]]

ToFileTimeUtc

Velocity

#set($numberResponse = $dateTime.ToFileTimeUtc())

JavaScript

var numberResponse = dateTime.ToFileTimeUtc();

Returns

[[Number Script API Type|Number]]

ToLocalTime

Velocity

#set($dateTimeResponse = $dateTime.ToLocalTime())

JavaScript

var dateTimeResponse = dateTime.ToLocalTime();

Returns

[[DateTime Script API Type|DateTime]]

ToLongDateString

Velocity

#set($stringResponse = $dateTime.ToLongDateString())

JavaScript

var stringResponse = dateTime.ToLongDateString();

Returns

[[String Script API Type|String]]

ToLongTimeString

Velocity

#set($stringResponse = $dateTime.ToLongTimeString())

JavaScript

var stringResponse = dateTime.ToLongTimeString();

Returns

[[String Script API Type|String]]

ToOADate

Velocity

#set($numberResponse = $dateTime.ToOADate())

JavaScript

var numberResponse = dateTime.ToOADate();

Returns

[[Number Script API Type|Number]]

ToShortDateString

Velocity

#set($stringResponse = $dateTime.ToShortDateString())

JavaScript

var stringResponse = dateTime.ToShortDateString();

Returns

[[String Script API Type|String]]

ToShortTimeString

Velocity

#set($stringResponse = $dateTime.ToShortTimeString())

JavaScript

var stringResponse = dateTime.ToShortTimeString();

Returns

[[String Script API Type|String]]

ToString

ToString Overload 1

Velocity

#set($stringResponse = $dateTime.ToString())

JavaScript

var stringResponse = dateTime.ToString();

ToString Overload 2

Velocity

#set($stringResponse = $dateTime.ToString($format))

JavaScript

var stringResponse = dateTime.ToString(format);

Parameters

Name	Type	Description	Required	Default	Options
format	`[[String Script API Type\|String]]`	Format	Required

Returns

[[String Script API Type|String]]

ToUniversalTime

Velocity

#set($dateTimeResponse = $dateTime.ToUniversalTime())

JavaScript

var dateTimeResponse = dateTime.ToUniversalTime();

Returns

[[DateTime Script API Type|DateTime]]