summaryrefslogtreecommitdiff
path: root/doc/classes/Skeleton2D.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-02-07 17:44:14 +0100
committerGitHub <noreply@github.com>2020-02-07 17:44:14 +0100
commit3fba20141b7cd1de15af3d5345cc681fc75a2099 (patch)
treeb0c68bb31f4f430ea2136733426d2ecd9e15dacf /doc/classes/Skeleton2D.xml
parentdf924469505dd7b3d5b5482790ec6d9ae5a11ae2 (diff)
parent915199243235db8d380ee6eaa3b0d177aec7589c (diff)
Merge pull request #35925 from seenloitering/doc-Skeleton2D
Add documentation for Skeleton2D
Diffstat (limited to 'doc/classes/Skeleton2D.xml')
-rw-r--r--doc/classes/Skeleton2D.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml
index ccae59d72c..558ba84068 100644
--- a/doc/classes/Skeleton2D.xml
+++ b/doc/classes/Skeleton2D.xml
@@ -4,6 +4,7 @@
Skeleton for 2D characters and animated objects.
</brief_description>
<description>
+ Skeleton2D parents a hierarchy of [Bone2D] objects. It is a requirement of [Bone2D]. Skeleton2D holds a reference to the rest pose of its children and acts as a single point of access to its bones.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/animation/2d_skeletons.html</link>
@@ -15,19 +16,21 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
+ Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling.
</description>
</method>
<method name="get_bone_count" qualifiers="const">
<return type="int">
</return>
<description>
- Returns the amount of bones in the skeleton.
+ Returns the number of [Bone2D] nodes in the node hierarchy parented by Skeleton2D.
</description>
</method>
<method name="get_skeleton" qualifiers="const">
<return type="RID">
</return>
<description>
+ Returns the [RID] of a Skeleton2D instance.
</description>
</method>
</methods>