diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-24 15:16:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-24 15:16:27 +0200 |
| commit | 3e4627ab6f450ae08bfa9a3bd792990d548169b1 (patch) | |
| tree | a71219ee925d7e8e4c4a76d19253ed69db0b804a | |
| parent | a5885d69878952e606c00fa4f0d7c69cc1820006 (diff) | |
| parent | 50f3a8e312d5449771ff12843471731996c0f2d6 (diff) | |
Merge pull request #42283 from Calinou/doc-print-push-error-warning
Improve documentation related to printing error/warning messages
| -rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 918581bc9b..613039754f 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -818,6 +818,7 @@ a = [1, 2, 3] print("a", "b", a) # Prints ab[1, 2, 3] [/codeblock] + [b]Note:[/b] Consider using [method push_error] and [method push_warning] to print error and warning messages instead of [method print]. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. </description> </method> <method name="print_debug" qualifiers="vararg"> @@ -891,6 +892,7 @@ [codeblock] push_error("test error") # Prints "test error" to debugger and terminal as error call [/codeblock] + [b]Note:[/b] Errors printed this way will not pause project execution. To print an error message and pause project execution in debug builds, use [code]assert(false, "test error")[/code] instead. </description> </method> <method name="push_warning"> |