summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-20 19:14:27 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-21 15:59:49 +0200
commit650b1db4b823155925877930d7800ac7f59cc334 (patch)
treefdbd532b4ad029608b4c6682403c3fc53e840dcc /doc/classes/OS.xml
parent2d1699ef82a29ef65d810194ee76dddc0d9e0389 (diff)
Add `print_verbose()` built-in function to print in verbose mode only
This can be used as a shorthand for: if OS.is_stdout_verbose(): print("...") Unlike `print_debug()`, this works in release builds too and can be toggled off in debug builds.
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 305258c8c5..8954469b4d 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -338,7 +338,7 @@
<method name="is_stdout_verbose" qualifiers="const">
<return type="bool" />
<description>
- Returns [code]true[/code] if the engine was executed with [code]-v[/code] (verbose stdout).
+ Returns [code]true[/code] if the engine was executed with the [code]--verbose[/code] or [code]-v[/code] command line argument, or if [member ProjectSettings.debug/settings/stdout/verbose_stdout] is [code]true[/code]. See also [method @GlobalScope.print_verbose].
</description>
</method>
<method name="is_userfs_persistent" qualifiers="const">