Files
godot-docs/classes/class_bone2d.rst
2019-01-07 10:14:12 +01:00

77 lines
2.8 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Bone2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Bone2D:
Bone2D
======
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Properties
----------
+---------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_property_default_length>` |
+---------------------------------------+-------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_property_rest>` |
+---------------------------------------+-------------------------------------------------------------+
Methods
-------
+---------------------------------------+-------------------------------------------------------------------------------------------+
| void | :ref:`apply_rest<class_Bone2D_method_apply_rest>` **(** **)** |
+---------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_method_get_index_in_skeleton>` **(** **)** const |
+---------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_method_get_skeleton_rest>` **(** **)** const |
+---------------------------------------+-------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_Bone2D_property_default_length:
- :ref:`float<class_float>` **default_length**
+----------+---------------------------+
| *Setter* | set_default_length(value) |
+----------+---------------------------+
| *Getter* | get_default_length() |
+----------+---------------------------+
.. _class_Bone2D_property_rest:
- :ref:`Transform2D<class_Transform2D>` **rest**
+----------+-----------------+
| *Setter* | set_rest(value) |
+----------+-----------------+
| *Getter* | get_rest() |
+----------+-----------------+
Method Descriptions
-------------------
.. _class_Bone2D_method_apply_rest:
- void **apply_rest** **(** **)**
.. _class_Bone2D_method_get_index_in_skeleton:
- :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const
.. _class_Bone2D_method_get_skeleton_rest:
- :ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** const