summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDrachenfels <drachu@gmail.com>2014-08-21 00:06:59 +0100
committerDrachenfels <drachu@gmail.com>2014-08-21 00:06:59 +0100
commit894b82a05fa82e84e994a8aac3e1893193bafbbf (patch)
tree18dad8163b2578942193e14f3d87b4bc9a5a66bf
parent89fa70706f9166765c3ac3f799225a467800f065 (diff)
- fix for typo and clarification to documentation
Previous example were slightly ambiguous, by adding 'fixed' NodePath tree to compare and one more example it will be easier to understand for future generation of developers.
-rw-r--r--doc/base/classes.xml16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index e5330925a9..527991d147 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -14261,7 +14261,21 @@
<argument index="0" name="path" type="NodePath">
</argument>
<description>
- Fetch a node. "path" must be valid (or else error will occur) and can be either the name of a child node, a relative path (from the current node to another node), or an absolute path to a node.[br] Examples ofa paths are: get_node("Sword") , get_node("../Swamp/Alligator") , get_node("/MyGame"). [br]Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_scene]).
+ Fetch a node. NodePath must be valid (or else error will occur) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node.[br] Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_scene]). Examples. Assume your current node is Character and following tree:[br]
+ root/[br]
+ root/Character[br]
+ root/Character/Sword[br]
+ root/Character/Backpack/Dagger[br]
+ root/MyGame[br]
+ root/Swamp/Alligator[br]
+ root/Swamp/Mosquito[br]
+ root/Swamp/Goblin[br]
+[br]
+ Possible paths are:[br]
+ - get_node("Sword")[br]
+ - get_node("Backpack/Dagger")[br]
+ - get_node("../Swamp/Alligator")[br]
+ - get_node("/root/MyGame")[br]
</description>
</method>
<method name="get_parent" qualifiers="const" >