From 650b1db4b823155925877930d7800ac7f59cc334 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Mon, 20 Sep 2021 19:14:27 +0200
Subject: 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.
---
 doc/classes/OS.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc/classes/OS.xml')

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">
-- 
cgit v1.2.3