Merge pull request #35925 from seenloitering/doc-Skeleton2D
Add documentation for Skeleton2D
This commit is contained in:
commit
3fba20141b
@ -4,6 +4,7 @@
|
|||||||
Skeleton for 2D characters and animated objects.
|
Skeleton for 2D characters and animated objects.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<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>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
<link>https://docs.godotengine.org/en/latest/tutorials/animation/2d_skeletons.html</link>
|
<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 index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_bone_count" qualifiers="const">
|
<method name="get_bone_count" qualifiers="const">
|
||||||
<return type="int">
|
<return type="int">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Returns the amount of bones in the skeleton.
|
Returns the number of [Bone2D] nodes in the node hierarchy parented by Skeleton2D.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_skeleton" qualifiers="const">
|
<method name="get_skeleton" qualifiers="const">
|
||||||
<return type="RID">
|
<return type="RID">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the [RID] of a Skeleton2D instance.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
Loading…
Reference in New Issue
Block a user