aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/Node.xml
diff options
context:
space:
mode:
authorGeoffrey2018-02-28 10:12:06 +0100
committerHein-Pieter van Braam2018-04-14 19:56:55 +0200
commit5d7b7f798af6a675149bf41939c9bb4c3c14d741 (patch)
tree708744d3945b930d9116355f429179df6ecd1e59 /doc/classes/Node.xml
parent710b57d493bcb2ffaad50abe59c1da5b33888aab (diff)
downloadgodot-5d7b7f798af6a675149bf41939c9bb4c3c14d741.tar.gz
godot-5d7b7f798af6a675149bf41939c9bb4c3c14d741.tar.zst
godot-5d7b7f798af6a675149bf41939c9bb4c3c14d741.zip
Made print_tree_pretty() function which displays scene tree graphically
(cherry picked from commit 8362ce4769b65f47c0d5d5a11d262a28a144e526)
Diffstat (limited to 'doc/classes/Node.xml')
-rw-r--r--doc/classes/Node.xml25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 9cd81ab13..98b3e2b49 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -438,7 +438,30 @@
<return type="void">
</return>
<description>
- Prints the scene to stdout. Used mainly for debugging purposes.
+ Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. Example output:
+ [codeblock]
+ TheGame
+ TheGame/Menu
+ TheGame/Menu/Label
+ TheGame/Menu/Camera2D
+ TheGame/SplashScreen
+ TheGame/SplashScreen/Camera2D
+ [/codeblock]
+ </description>
+ </method>
+ <method name="print_tree_pretty">
+ <return type="void">
+ </return>
+ <description>
+ Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output:
+ [codeblock]
+ ┖╴TheGame
+ ┠╴Menu
+ ┃ ┠╴Label
+ ┃ ┖╴Camera2D
+ ┖-SplashScreen
+ ┖╴Camera2D
+ [/codeblock]
</description>
</method>
<method name="propagate_call">