Browse Source

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.

(cherry picked from commit 49741d9464e1f3ddda077dc08034d26d201be758)
Fabio Alessandrelli 4 years ago
parent
commit
53988c7de3
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/OS.xml

+ 1 - 0
doc/classes/OS.xml

@@ -529,6 +529,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">