godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
classes/class_bone2d.rst
View File

@@ -47,25 +47,25 @@ Methods
.. table::
:widths: auto
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_rest<class_Bone2D_method_apply_rest>` **(** **)** |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_autocalculate_length_and_angle<class_Bone2D_method_get_autocalculate_length_and_angle>` **(** **)** |const| |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bone_angle<class_Bone2D_method_get_bone_angle>` **(** **)** |const| |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_method_get_index_in_skeleton>` **(** **)** |const| |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Bone2D_method_get_length>` **(** **)** |const| |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_method_get_skeleton_rest>` **(** **)** |const| |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autocalculate_length_and_angle<class_Bone2D_method_set_autocalculate_length_and_angle>` **(** :ref:`bool<class_bool>` auto_calculate **)** |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bone_angle<class_Bone2D_method_set_bone_angle>` **(** :ref:`float<class_float>` angle **)** |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_Bone2D_method_set_length>` **(** :ref:`float<class_float>` length **)** |
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`apply_rest<class_Bone2D_method_apply_rest>`\ (\ ) |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_autocalculate_length_and_angle<class_Bone2D_method_get_autocalculate_length_and_angle>`\ (\ ) |const| |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bone_angle<class_Bone2D_method_get_bone_angle>`\ (\ ) |const| |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_method_get_index_in_skeleton>`\ (\ ) |const| |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Bone2D_method_get_length>`\ (\ ) |const| |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_method_get_skeleton_rest>`\ (\ ) |const| |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_autocalculate_length_and_angle<class_Bone2D_method_set_autocalculate_length_and_angle>`\ (\ auto_calculate\: :ref:`bool<class_bool>`\ ) |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bone_angle<class_Bone2D_method_set_bone_angle>`\ (\ angle\: :ref:`float<class_float>`\ ) |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_length<class_Bone2D_method_set_length>`\ (\ length\: :ref:`float<class_float>`\ ) |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -84,8 +84,8 @@ Property Descriptions
.. rst-class:: classref-property-setget
- void **set_rest** **(** :ref:`Transform2D<class_Transform2D>` value **)**
- :ref:`Transform2D<class_Transform2D>` **get_rest** **(** **)**
- |void| **set_rest**\ (\ value\: :ref:`Transform2D<class_Transform2D>`\ )
- :ref:`Transform2D<class_Transform2D>` **get_rest**\ (\ )
Rest transform of the bone. You can reset the node's transforms to this value using :ref:`apply_rest<class_Bone2D_method_apply_rest>`.
@@ -102,7 +102,7 @@ Method Descriptions
.. rst-class:: classref-method
void **apply_rest** **(** **)**
|void| **apply_rest**\ (\ )
Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.transform<class_Node2D_property_transform>` to :ref:`rest<class_Bone2D_property_rest>`.
@@ -114,7 +114,7 @@ Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.tra
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_autocalculate_length_and_angle** **(** **)** |const|
:ref:`bool<class_bool>` **get_autocalculate_length_and_angle**\ (\ ) |const|
Returns whether this **Bone2D** is going to autocalculate its length and bone angle using its first **Bone2D** child node, if one exists. If there are no **Bone2D** children, then it cannot autocalculate these values and will print a warning.
@@ -126,7 +126,7 @@ Returns whether this **Bone2D** is going to autocalculate its length and bone an
.. rst-class:: classref-method
:ref:`float<class_float>` **get_bone_angle** **(** **)** |const|
:ref:`float<class_float>` **get_bone_angle**\ (\ ) |const|
Returns the angle of the bone in the **Bone2D**.
@@ -140,7 +140,7 @@ Returns the angle of the bone in the **Bone2D**.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_index_in_skeleton** **(** **)** |const|
:ref:`int<class_int>` **get_index_in_skeleton**\ (\ ) |const|
Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D<class_Skeleton2D>`.
@@ -152,7 +152,7 @@ Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D<cl
.. rst-class:: classref-method
:ref:`float<class_float>` **get_length** **(** **)** |const|
:ref:`float<class_float>` **get_length**\ (\ ) |const|
Returns the length of the bone in the **Bone2D** node.
@@ -164,7 +164,7 @@ Returns the length of the bone in the **Bone2D** node.
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** |const|
:ref:`Transform2D<class_Transform2D>` **get_skeleton_rest**\ (\ ) |const|
Returns the node's :ref:`rest<class_Bone2D_property_rest>` :ref:`Transform2D<class_Transform2D>` if it doesn't have a parent, or its rest pose relative to its parent.
@@ -176,7 +176,7 @@ Returns the node's :ref:`rest<class_Bone2D_property_rest>` :ref:`Transform2D<cla
.. rst-class:: classref-method
void **set_autocalculate_length_and_angle** **(** :ref:`bool<class_bool>` auto_calculate **)**
|void| **set_autocalculate_length_and_angle**\ (\ auto_calculate\: :ref:`bool<class_bool>`\ )
When set to ``true``, the **Bone2D** node will attempt to automatically calculate the bone angle and length using the first child **Bone2D** node, if one exists. If none exist, the **Bone2D** cannot automatically calculate these values and will print a warning.
@@ -188,7 +188,7 @@ When set to ``true``, the **Bone2D** node will attempt to automatically calculat
.. rst-class:: classref-method
void **set_bone_angle** **(** :ref:`float<class_float>` angle **)**
|void| **set_bone_angle**\ (\ angle\: :ref:`float<class_float>`\ )
Sets the bone angle for the **Bone2D**. This is typically set to the rotation from the **Bone2D** to a child **Bone2D** node.
@@ -202,7 +202,7 @@ Sets the bone angle for the **Bone2D**. This is typically set to the rotation fr
.. rst-class:: classref-method
void **set_length** **(** :ref:`float<class_float>` length **)**
|void| **set_length**\ (\ length\: :ref:`float<class_float>`\ )
Sets the length of the bone in the **Bone2D**.
@@ -213,3 +213,4 @@ Sets the length of the bone in the **Bone2D**.
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`