Add documentation for Bone2D

(cherry picked from commit c12fc1ade1)
This commit is contained in:
Nathan Lovato 2019-06-12 19:58:13 +09:00 committed by Rémi Verschelde
parent 7cd696f1b5
commit 040e1dd411
1 changed files with 10 additions and 0 deletions

View File

@ -1,8 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Bone2D" inherits="Node2D" category="Core" version="3.1.2"> <class name="Bone2D" inherits="Node2D" category="Core" version="3.1.2">
<brief_description> <brief_description>
Joint used with [Skeleton2D] to control and animate other nodes.
</brief_description> </brief_description>
<description> <description>
Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [class Node2D] nodes.
You can use [code]Bone2D[/code] and [code]Skeleton2D[/code] nodes to animate 2D meshes created with the Polygon 2D UV editor.
Each bone has a [member rest] transform that you can reset to with [method apply_rest]. These rest poses are relative to the bone's parent.
If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -11,25 +16,30 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Stores the node's current transforms in [member rest].
</description> </description>
</method> </method>
<method name="get_index_in_skeleton" qualifiers="const"> <method name="get_index_in_skeleton" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the node's index as part of the entire skeleton. See [Skeleton2D].
</description> </description>
</method> </method>
<method name="get_skeleton_rest" qualifiers="const"> <method name="get_skeleton_rest" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D">
</return> </return>
<description> <description>
Returns the node's [member rest] [code]Transform2D[/code] if it doesn't have a parent, or its rest pose relative to its parent.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="default_length" type="float" setter="set_default_length" getter="get_default_length"> <member name="default_length" type="float" setter="set_default_length" getter="get_default_length">
Length of the bone's representation drawn in the editor's viewport in pixels.
</member> </member>
<member name="rest" type="Transform2D" setter="set_rest" getter="get_rest"> <member name="rest" type="Transform2D" setter="set_rest" getter="get_rest">
Rest transform of the bone. You can reset the node's transforms to this value using [member apply_rest].
</member> </member>
</members> </members>
<constants> <constants>