summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2020-12-13 13:56:45 +0100
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2020-12-13 13:56:45 +0100
commit49741d9464e1f3ddda077dc08034d26d201be758 (patch)
treedea3b5b94f95433a34ed378a7cfe460c3c4b599b /doc
parentdc589a64e6a8c320ae286e3fa8c9533b58a286ca (diff)
Add important note about OS.get_unixtime.
Should NEVER be used for precise time computations since its return values are not guaranteed to be monotonic.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/OS.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index ec47d455a9..65a815a603 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -356,6 +356,7 @@
</return>
<description>
Returns the current UNIX epoch timestamp.
+ [b]Important:[/b] This is the system clock that the user can manully set. [b]Never use[/b] this method for precise time calculation since its results are also subject to automatic adjustments by the operating system. [b]Always use[/b] [method get_ticks_usec] or [method get_ticks_msec] for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease).
</description>
</method>
<method name="get_unix_time_from_datetime" qualifiers="const">