GetTimeProperty

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.

int GetTimeProperty (int timestamp, int which[, int utc])

Usage

Parameters

• timestamp: The timestamp to localize.
• which: Which attribute to return; see the #Time properties table below.
• utc: If true, the timestamp will be localized using the UTC timezone, local timezone otherwise.

Time properties

Property	Range	Description
TM_SECOND (0)	[0 - 61]	Seconds. Result is generally within [0, 59] but may very rarely exceed due to leap seconds.
TM_MINUTE (1)	[0 - 59]	Minutes
TM_HOUR (2)	[0, 23]	Hours
TM_DAY (3)	[1, 31]	Days
TM_MONTH (4)	[0, 11]	Month of the year
TM_YEAR (5)	[1901, 2038]	Year
TM_WEEKDAY (6)	[0, 6]	Weekday (Sunday is 0)

Return value

Localizes the given timestamp and returns an attribute of it.

Note that due to ACS's limitations, the timestamp is suspectible to the year 2038 problem.

Examples

The following script checks if the game is being played on a Thursday the 20th.

script 1 OPEN
{
    if (GetTimeProperty(SystemTime(), TM_WEEKDAY) == 4 && GetTimeProperty(SystemTime(), TM_DAY) == 20)
        PrintBold(s:"Happy Thursday the 20th!");
}

See also

• SystemTime
• Strftime