summaryrefslogtreecommitdiff
path: root/doc/classes/Time.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Time.xml')
-rw-r--r--doc/classes/Time.xml7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml
index dd83fa54ff..5fc85c869b 100644
--- a/doc/classes/Time.xml
+++ b/doc/classes/Time.xml
@@ -43,13 +43,14 @@
Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD).
</description>
</method>
- <method name="get_datetime_dict_from_string" qualifiers="const">
+ <method name="get_datetime_dict_from_datetime_string" qualifiers="const">
<return type="Dictionary" />
<argument index="0" name="datetime" type="String" />
<argument index="1" name="weekday" type="bool" />
<description>
Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code].
If [code]weekday[/code] is false, then the [code]weekday[/code] entry is excluded (the calculation is relatively expensive).
+ [b]Note:[/b] Any decimal fraction in the time string will be ignored silently.
</description>
</method>
<method name="get_datetime_dict_from_system" qualifiers="const">
@@ -67,7 +68,7 @@
The returned Dictionary's values will be the same as the [method 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.
</description>
</method>
- <method name="get_datetime_string_from_dict" qualifiers="const">
+ <method name="get_datetime_string_from_datetime_dict" qualifiers="const">
<return type="String" />
<argument index="0" name="datetime" type="Dictionary" />
<argument index="1" name="use_space" type="bool" />
@@ -171,12 +172,14 @@
<description>
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.
[b]Note:[/b] 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.
+ [b]Note:[/b] Any decimal fraction in the time string will be ignored silently.
</description>
</method>
<method name="get_unix_time_from_system" qualifiers="const">
<return type="float" />
<description>
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.
+ [b]Note:[/b] Unlike other methods that use integer timestamps, this method returns the timestamp as a [float] for sub-second precision.
</description>
</method>
</methods>