summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-01-10 15:51:16 +0100
committerGitHub <noreply@github.com>2020-01-10 15:51:16 +0100
commita24aa591af50408551b7310b2d8cee8969850c9a (patch)
tree132fce68fce1042e81d132003bb2d5a717e37717
parentc4601153694ed43fafbf88bcf85a9a74c47dda98 (diff)
parent74ae1ca61648004a4a3ca5d32d760d422f941600 (diff)
Merge pull request #34991 from Calinou/doc-os-is-debug-build
Improve the `OS.is_debug_build()` documentation
-rw-r--r--doc/classes/OS.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 3550ef6b5f..2236c42094 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -613,9 +613,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.
+ Returns [code]true[/code] if the Godot binary used to run the project is a [i]debug[/i] export template, or when running in the editor.
+ Returns [code]false[/code] if the Godot binary used to run the project is a [i]release[/i] export template.
+ To check whether the Godot binary used to run the project is an export template (debug or release), use [code]OS.has_feature("standalone")[/code] instead.
</description>
</method>
<method name="is_ok_left_and_cancel_right" qualifiers="const">