summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Warden <nathan@nathanwarden.com>2017-10-02 22:54:50 -0500
committerNathan Warden <nathan@nathanwarden.com>2017-10-03 09:30:04 -0500
commit0b3a49ef182aa135a9f5e1125e489f445f51832a (patch)
treec8e342a102206185bde600417b54ab92fe1bff42
parent6dc1025e6313d711939269e1578fff5ffc0cd30a (diff)
Updated some documentation for the OS class.
-rw-r--r--doc/classes/OS.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 65200c4769..d584e3ea27 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -326,6 +326,7 @@
<return type="int">
</return>
<description>
+ Returns the amount of static memory being used by the program in bytes.
</description>
</method>
<method name="get_system_dir" qualifiers="const">
@@ -340,6 +341,7 @@
<return type="int">
</return>
<description>
+ Returns the epoch time of the operating system in seconds.
</description>
</method>
<method name="get_ticks_msec" qualifiers="const">
@@ -435,6 +437,9 @@
<return type="bool">
</return>
<description>
+ Returns [code]true[/code] if the build is a debug build.
+ Returns [code]true[/code] when running in the editor.
+ Returns [code]false[/code] if the build is a release build.
</description>
</method>
<method name="is_in_low_processor_usage_mode" qualifiers="const">
@@ -476,6 +481,7 @@
<return type="bool">
</return>
<description>
+ Returns [code]true[/code] if synchronizing the framerate to the monitor's refresh rate is enabled.
</description>
</method>
<method name="is_window_fullscreen" qualifiers="const">
@@ -688,6 +694,7 @@
<argument index="0" name="enable" type="bool">
</argument>
<description>
+ If [code]true[/code] the framerate will synchronize to the monitor's refresh rate.
</description>
</method>
<method name="set_window_fullscreen">