From 4aeb7b41cbe589e704432a5a571e0de9d2718b7c Mon Sep 17 00:00:00 2001 From: willnationsdev Date: Wed, 13 Nov 2019 12:08:39 -0600 Subject: [PATCH] Added more in-depth examples of NodePaths in API docs. (cherry picked from commit db0082534cba40ec685d95bc405ad14594d8d130) --- doc/classes/NodePath.xml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 37c999f32ee..aa76411ac90 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -5,8 +5,21 @@ A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the [code]size[/code] property of the [code]texture[/code] resource on the node named [code]"Sprite"[/code] which is a child of the other named nodes in the path. - You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [code]NodePath[/code] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. - A [code]NodePath[/code] is composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of "subnames" which can be resources or properties. + You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [NodePath] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. + A [NodePath] is composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of "subnames" which can be resources or properties. + Some examples of NodePaths include the following: + [codeblock] + # No leading slash means it is relative to the current node. + @"A" # Immediate child A + @"A/B" # A's child B + @"." # The current node. + @".." # The parent node. + @"../C" # A sibling node C. + # A leading slash means it is absolute from the SceneTree. + @"/root" # Equivalent to get_tree().get_root(). + @"/root/Main" # If your main scene's root node were named "Main". + @"/root/MyAutoload" # If you have an autoloaded node or scene. + [/codeblock]