Table of Contents

Class Time

A singleton for working with time data.

Inheritance
Time

Remarks

The Time singleton allows converting time between various formats and also getting time information from the system.

This class conforms with as many of the ISO 8601 standards as possible. All dates follow the Proleptic Gregorian calendar. As such, the day before 1582-10-15 is 1582-10-14, not 1582-10-04. The year before 1 AD (aka 1 BC) is number 0, with the year before that (2 BC) being -1, etc.

Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually.

When getting time information from the system, the time can either be in the local timezone or UTC depending on the utc parameter. However, the get_unix_time_from_system method always uses UTC as it returns the seconds passed since the Unix epoch.

Important: The _from_system methods use the system clock that the user can manually set. Never use this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. Always use get_ticks_usec or get_ticks_msec for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease).

Methods

get_date_dict_from_system(bool)

Qualifiers: const

Returns the current date as a dictionary of keys: year, month, day, and weekday.

The returned values are in the system's local time when utc is false, otherwise they are in UTC.

Dictionary get_date_dict_from_system(bool utc)

Parameters

utc bool

get_date_dict_from_unix_time(int)

Qualifiers: const

Converts the given Unix timestamp to a dictionary of keys: year, month, day, and weekday.

Dictionary get_date_dict_from_unix_time(int unix_time_val)

Parameters

unix_time_val int

get_date_string_from_system(bool)

Qualifiers: const

Returns the current date as an ISO 8601 date string (YYYY-MM-DD).

The returned values are in the system's local time when utc is false, otherwise they are in UTC.

String get_date_string_from_system(bool utc)

Parameters

utc bool

get_date_string_from_unix_time(int)

Qualifiers: const

Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD).

String get_date_string_from_unix_time(int unix_time_val)

Parameters

unix_time_val int

get_datetime_dict_from_datetime_string(String, bool)

Qualifiers: const

Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: year, month, day, weekday, hour, minute, and second.

If weekday is false, then the weekday entry is excluded (the calculation is relatively expensive).

Note: Any decimal fraction in the time string will be ignored silently.

Dictionary get_datetime_dict_from_datetime_string(String datetime, bool weekday)

Parameters

datetime String
weekday bool

get_datetime_dict_from_system(bool)

Qualifiers: const

Returns the current date as a dictionary of keys: year, month, day, weekday, hour, minute, second, and dst (Daylight Savings Time).

Dictionary get_datetime_dict_from_system(bool utc)

Parameters

utc bool

get_datetime_dict_from_unix_time(int)

Qualifiers: const

Converts the given Unix timestamp to a dictionary of keys: year, month, day, weekday, hour, minute, and second.

The returned Dictionary's values will be the same as the Time.get_datetime_dict_from_system if the Unix timestamp is the current time, with the exception of Daylight Savings Time as it cannot be determined from the epoch.

Dictionary get_datetime_dict_from_unix_time(int unix_time_val)

Parameters

unix_time_val int

get_datetime_string_from_datetime_dict(Dictionary, bool)

Qualifiers: const

Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS).

The given dictionary can be populated with the following keys: year, month, day, hour, minute, and second. Any other entries (including dst) are ignored.

If the dictionary is empty, 0 is returned. If some keys are omitted, they default to the equivalent values for the Unix epoch timestamp 0 (1970-01-01 at 00:00:00).

If use_space is true, the date and time bits are separated by an empty space character instead of the letter T.

String get_datetime_string_from_datetime_dict(Dictionary datetime, bool use_space)

Parameters

datetime Dictionary
use_space bool

get_datetime_string_from_system(bool, bool)

Qualifiers: const

Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS).

The returned values are in the system's local time when utc is false, otherwise they are in UTC.

If use_space is true, the date and time bits are separated by an empty space character instead of the letter T.

String get_datetime_string_from_system(bool utc, bool use_space)

Parameters

utc bool
use_space bool

get_datetime_string_from_unix_time(int, bool)

Qualifiers: const

Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS).

If use_space is true, the date and time bits are separated by an empty space character instead of the letter T.

String get_datetime_string_from_unix_time(int unix_time_val, bool use_space)

Parameters

unix_time_val int
use_space bool

get_offset_string_from_offset_minutes(int)

Qualifiers: const

Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00".

String get_offset_string_from_offset_minutes(int offset_minutes)

Parameters

offset_minutes int

get_ticks_msec

Qualifiers: const

Returns the amount of time passed in milliseconds since the engine started.

Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly 500 million years).

int get_ticks_msec

get_ticks_usec

Qualifiers: const

Returns the amount of time passed in microseconds since the engine started.

Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly half a million years).

int get_ticks_usec

get_time_dict_from_system(bool)

Qualifiers: const

Returns the current time as a dictionary of keys: hour, minute, and second.

The returned values are in the system's local time when utc is false, otherwise they are in UTC.

Dictionary get_time_dict_from_system(bool utc)

Parameters

utc bool

get_time_dict_from_unix_time(int)

Qualifiers: const

Converts the given time to a dictionary of keys: hour, minute, and second.

Dictionary get_time_dict_from_unix_time(int unix_time_val)

Parameters

unix_time_val int

get_time_string_from_system(bool)

Qualifiers: const

Returns the current time as an ISO 8601 time string (HH:MM:SS).

The returned values are in the system's local time when utc is false, otherwise they are in UTC.

String get_time_string_from_system(bool utc)

Parameters

utc bool

get_time_string_from_unix_time(int)

Qualifiers: const

Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS).

String get_time_string_from_unix_time(int unix_time_val)

Parameters

unix_time_val int

get_time_zone_from_system

Qualifiers: const

Returns the current time zone as a dictionary of keys: bias and name.

  • bias is the offset from UTC in minutes, since not all time zones are multiples of an hour from UTC.

  • name is the localized name of the time zone, according to the OS locale settings of the current user.

Dictionary get_time_zone_from_system

get_unix_time_from_datetime_dict(Dictionary)

Qualifiers: const

Converts a dictionary of time values to a Unix timestamp.

The given dictionary can be populated with the following keys: year, month, day, hour, minute, and second. Any other entries (including dst) are ignored.

If the dictionary is empty, 0 is returned. If some keys are omitted, they default to the equivalent values for the Unix epoch timestamp 0 (1970-01-01 at 00:00:00).

You can pass the output from Time.get_datetime_dict_from_unix_time directly into this function and get the same as what was put in.

Note: Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime dictionary.

int get_unix_time_from_datetime_dict(Dictionary datetime)

Parameters

datetime Dictionary

get_unix_time_from_datetime_string(String)

Qualifiers: const

Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both.

Note: Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime string.

Note: Any decimal fraction in the time string will be ignored silently.

int get_unix_time_from_datetime_string(String datetime)

Parameters

datetime String

get_unix_time_from_system

Qualifiers: const

Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. The Unix timestamp is the number of seconds passed since 1970-01-01 at 00:00:00, the Unix epoch.

Note: Unlike other methods that use integer timestamps, this method returns the timestamp as a float for sub-second precision.

float get_unix_time_from_system