godot/doc/classes/Skeleton2D.xml

46 lines
1.5 KiB
XML
Raw Normal View History

2018-05-12 07:38:00 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Skeleton2D" inherits="Node2D" version="3.4">
2018-05-12 07:38:00 +00:00
<brief_description>
2019-10-10 03:10:28 +00:00
Skeleton for 2D characters and animated objects.
2018-05-12 07:38:00 +00:00
</brief_description>
<description>
2020-02-14 16:51:56 +00:00
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.
2018-05-12 07:38:00 +00:00
</description>
<tutorials>
<link>https://docs.godotengine.org/en/3.3/tutorials/animation/2d_skeletons.html</link>
2018-05-12 07:38:00 +00:00
</tutorials>
<methods>
<method name="get_bone">
<return type="Bone2D">
</return>
2018-08-20 22:35:30 +00:00
<argument index="0" name="idx" type="int">
2018-05-12 07:38:00 +00:00
</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.
2018-05-12 07:38:00 +00:00
</description>
</method>
<method name="get_bone_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of [Bone2D] nodes in the node hierarchy parented by Skeleton2D.
2018-05-12 07:38:00 +00:00
</description>
</method>
<method name="get_skeleton" qualifiers="const">
<return type="RID">
</return>
<description>
Returns the [RID] of a Skeleton2D instance.
2018-05-12 07:38:00 +00:00
</description>
</method>
</methods>
2019-02-18 08:35:10 +00:00
<signals>
<signal name="bone_setup_changed">
<description>
</description>
</signal>
</signals>
2018-05-12 07:38:00 +00:00
<constants>
</constants>
</class>