mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
@@ -59,47 +59,47 @@ Methods
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_SkeletonModification2DJiggle_method_get_collision_mask>` **(** **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`get_jiggle_joint_bone2d_node<class_SkeletonModification2DJiggle_method_get_jiggle_joint_bone2d_node>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_jiggle_joint_bone_index<class_SkeletonModification2DJiggle_method_get_jiggle_joint_bone_index>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_damping<class_SkeletonModification2DJiggle_method_get_jiggle_joint_damping>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_jiggle_joint_gravity<class_SkeletonModification2DJiggle_method_get_jiggle_joint_gravity>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_mass<class_SkeletonModification2DJiggle_method_get_jiggle_joint_mass>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_jiggle_joint_override<class_SkeletonModification2DJiggle_method_get_jiggle_joint_override>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_stiffness<class_SkeletonModification2DJiggle_method_get_jiggle_joint_stiffness>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_jiggle_joint_use_gravity<class_SkeletonModification2DJiggle_method_get_jiggle_joint_use_gravity>` **(** :ref:`int<class_int>` joint_idx **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_colliders<class_SkeletonModification2DJiggle_method_get_use_colliders>` **(** **)** |const| |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_SkeletonModification2DJiggle_method_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_bone2d_node<class_SkeletonModification2DJiggle_method_set_jiggle_joint_bone2d_node>` **(** :ref:`int<class_int>` joint_idx, :ref:`NodePath<class_NodePath>` bone2d_node **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_bone_index<class_SkeletonModification2DJiggle_method_set_jiggle_joint_bone_index>` **(** :ref:`int<class_int>` joint_idx, :ref:`int<class_int>` bone_idx **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_damping<class_SkeletonModification2DJiggle_method_set_jiggle_joint_damping>` **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` damping **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_gravity<class_SkeletonModification2DJiggle_method_set_jiggle_joint_gravity>` **(** :ref:`int<class_int>` joint_idx, :ref:`Vector2<class_Vector2>` gravity **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_mass<class_SkeletonModification2DJiggle_method_set_jiggle_joint_mass>` **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` mass **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_override<class_SkeletonModification2DJiggle_method_set_jiggle_joint_override>` **(** :ref:`int<class_int>` joint_idx, :ref:`bool<class_bool>` override **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_stiffness<class_SkeletonModification2DJiggle_method_set_jiggle_joint_stiffness>` **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` stiffness **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_jiggle_joint_use_gravity<class_SkeletonModification2DJiggle_method_set_jiggle_joint_use_gravity>` **(** :ref:`int<class_int>` joint_idx, :ref:`bool<class_bool>` use_gravity **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_colliders<class_SkeletonModification2DJiggle_method_set_use_colliders>` **(** :ref:`bool<class_bool>` use_colliders **)** |
|
||||
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_SkeletonModification2DJiggle_method_get_collision_mask>`\ (\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`get_jiggle_joint_bone2d_node<class_SkeletonModification2DJiggle_method_get_jiggle_joint_bone2d_node>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_jiggle_joint_bone_index<class_SkeletonModification2DJiggle_method_get_jiggle_joint_bone_index>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_damping<class_SkeletonModification2DJiggle_method_get_jiggle_joint_damping>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_jiggle_joint_gravity<class_SkeletonModification2DJiggle_method_get_jiggle_joint_gravity>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_mass<class_SkeletonModification2DJiggle_method_get_jiggle_joint_mass>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_jiggle_joint_override<class_SkeletonModification2DJiggle_method_get_jiggle_joint_override>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_jiggle_joint_stiffness<class_SkeletonModification2DJiggle_method_get_jiggle_joint_stiffness>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_jiggle_joint_use_gravity<class_SkeletonModification2DJiggle_method_get_jiggle_joint_use_gravity>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_colliders<class_SkeletonModification2DJiggle_method_get_use_colliders>`\ (\ ) |const| |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_collision_mask<class_SkeletonModification2DJiggle_method_set_collision_mask>`\ (\ collision_mask\: :ref:`int<class_int>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_bone2d_node<class_SkeletonModification2DJiggle_method_set_jiggle_joint_bone2d_node>`\ (\ joint_idx\: :ref:`int<class_int>`, bone2d_node\: :ref:`NodePath<class_NodePath>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_bone_index<class_SkeletonModification2DJiggle_method_set_jiggle_joint_bone_index>`\ (\ joint_idx\: :ref:`int<class_int>`, bone_idx\: :ref:`int<class_int>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_damping<class_SkeletonModification2DJiggle_method_set_jiggle_joint_damping>`\ (\ joint_idx\: :ref:`int<class_int>`, damping\: :ref:`float<class_float>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_gravity<class_SkeletonModification2DJiggle_method_set_jiggle_joint_gravity>`\ (\ joint_idx\: :ref:`int<class_int>`, gravity\: :ref:`Vector2<class_Vector2>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_mass<class_SkeletonModification2DJiggle_method_set_jiggle_joint_mass>`\ (\ joint_idx\: :ref:`int<class_int>`, mass\: :ref:`float<class_float>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_override<class_SkeletonModification2DJiggle_method_set_jiggle_joint_override>`\ (\ joint_idx\: :ref:`int<class_int>`, override\: :ref:`bool<class_bool>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_stiffness<class_SkeletonModification2DJiggle_method_set_jiggle_joint_stiffness>`\ (\ joint_idx\: :ref:`int<class_int>`, stiffness\: :ref:`float<class_float>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_jiggle_joint_use_gravity<class_SkeletonModification2DJiggle_method_set_jiggle_joint_use_gravity>`\ (\ joint_idx\: :ref:`int<class_int>`, use_gravity\: :ref:`bool<class_bool>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_use_colliders<class_SkeletonModification2DJiggle_method_set_use_colliders>`\ (\ use_colliders\: :ref:`bool<class_bool>`\ ) |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
@@ -118,8 +118,8 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_damping** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_damping** **(** **)**
|
||||
- |void| **set_damping**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_damping**\ (\ )
|
||||
|
||||
The default amount of damping applied to the Jiggle joints, if they are not overridden. Higher values lead to more of the calculated velocity being applied.
|
||||
|
||||
@@ -135,8 +135,8 @@ The default amount of damping applied to the Jiggle joints, if they are not over
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_gravity** **(** :ref:`Vector2<class_Vector2>` value **)**
|
||||
- :ref:`Vector2<class_Vector2>` **get_gravity** **(** **)**
|
||||
- |void| **set_gravity**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
|
||||
- :ref:`Vector2<class_Vector2>` **get_gravity**\ (\ )
|
||||
|
||||
The default amount of gravity applied to the Jiggle joints, if they are not overridden.
|
||||
|
||||
@@ -152,8 +152,8 @@ The default amount of gravity applied to the Jiggle joints, if they are not over
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_jiggle_data_chain_length** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_jiggle_data_chain_length** **(** **)**
|
||||
- |void| **set_jiggle_data_chain_length**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_jiggle_data_chain_length**\ (\ )
|
||||
|
||||
The amount of Jiggle joints in the Jiggle modification.
|
||||
|
||||
@@ -169,8 +169,8 @@ The amount of Jiggle joints in the Jiggle modification.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_mass** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_mass** **(** **)**
|
||||
- |void| **set_mass**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_mass**\ (\ )
|
||||
|
||||
The default amount of mass assigned to the Jiggle joints, if they are not overridden. Higher values lead to faster movements and more overshooting.
|
||||
|
||||
@@ -186,8 +186,8 @@ The default amount of mass assigned to the Jiggle joints, if they are not overri
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_stiffness** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_stiffness** **(** **)**
|
||||
- |void| **set_stiffness**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_stiffness**\ (\ )
|
||||
|
||||
The default amount of stiffness assigned to the Jiggle joints, if they are not overridden. Higher values act more like springs, quickly moving into the correct position.
|
||||
|
||||
@@ -203,8 +203,8 @@ The default amount of stiffness assigned to the Jiggle joints, if they are not o
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_target_node** **(** :ref:`NodePath<class_NodePath>` value **)**
|
||||
- :ref:`NodePath<class_NodePath>` **get_target_node** **(** **)**
|
||||
- |void| **set_target_node**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
|
||||
- :ref:`NodePath<class_NodePath>` **get_target_node**\ (\ )
|
||||
|
||||
The NodePath to the node that is the target for the Jiggle modification. This node is what the Jiggle chain will attempt to rotate the bone chain to.
|
||||
|
||||
@@ -220,8 +220,8 @@ The NodePath to the node that is the target for the Jiggle modification. This no
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_use_gravity** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_use_gravity** **(** **)**
|
||||
- |void| **set_use_gravity**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **get_use_gravity**\ (\ )
|
||||
|
||||
Whether the gravity vector, :ref:`gravity<class_SkeletonModification2DJiggle_property_gravity>`, should be applied to the Jiggle joints, assuming they are not overriding the default settings.
|
||||
|
||||
@@ -238,7 +238,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_collision_mask** **(** **)** |const|
|
||||
:ref:`int<class_int>` **get_collision_mask**\ (\ ) |const|
|
||||
|
||||
Returns the collision mask used by the Jiggle modifier when collisions are enabled.
|
||||
|
||||
@@ -250,7 +250,7 @@ Returns the collision mask used by the Jiggle modifier when collisions are enabl
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`NodePath<class_NodePath>` **get_jiggle_joint_bone2d_node** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`NodePath<class_NodePath>` **get_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -262,7 +262,7 @@ Returns the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle joint at ``j
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_jiggle_joint_bone_index** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`int<class_int>` **get_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the index of the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -274,7 +274,7 @@ Returns the index of the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_jiggle_joint_damping** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`float<class_float>` **get_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the amount of damping of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -286,7 +286,7 @@ Returns the amount of damping of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Vector2<class_Vector2>` **get_jiggle_joint_gravity** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`Vector2<class_Vector2>` **get_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns a :ref:`Vector2<class_Vector2>` representing the amount of gravity the Jiggle joint at ``joint_idx`` is influenced by.
|
||||
|
||||
@@ -298,7 +298,7 @@ Returns a :ref:`Vector2<class_Vector2>` representing the amount of gravity the J
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_jiggle_joint_mass** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`float<class_float>` **get_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the amount of mass of the jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -310,7 +310,7 @@ Returns the amount of mass of the jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **get_jiggle_joint_override** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`bool<class_bool>` **get_jiggle_joint_override**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns a boolean that indicates whether the joint at ``joint_idx`` is overriding the default Jiggle joint data defined in the modification.
|
||||
|
||||
@@ -322,7 +322,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is overridin
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **get_jiggle_joint_stiffness** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`float<class_float>` **get_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the stiffness of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -334,7 +334,7 @@ Returns the stiffness of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **get_jiggle_joint_use_gravity** **(** :ref:`int<class_int>` joint_idx **)** |const|
|
||||
:ref:`bool<class_bool>` **get_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns a boolean that indicates whether the joint at ``joint_idx`` is using gravity or not.
|
||||
|
||||
@@ -346,7 +346,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is using gra
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **get_use_colliders** **(** **)** |const|
|
||||
:ref:`bool<class_bool>` **get_use_colliders**\ (\ ) |const|
|
||||
|
||||
Returns whether the jiggle modifier is taking physics colliders into account when solving.
|
||||
|
||||
@@ -358,7 +358,7 @@ Returns whether the jiggle modifier is taking physics colliders into account whe
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
|void| **set_collision_mask**\ (\ collision_mask\: :ref:`int<class_int>`\ )
|
||||
|
||||
Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account.
|
||||
|
||||
@@ -370,7 +370,7 @@ Sets the collision mask that the Jiggle modifier will use when reacting to colli
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_bone2d_node** **(** :ref:`int<class_int>` joint_idx, :ref:`NodePath<class_NodePath>` bone2d_node **)**
|
||||
|void| **set_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int<class_int>`, bone2d_node\: :ref:`NodePath<class_NodePath>`\ )
|
||||
|
||||
Sets the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -382,7 +382,7 @@ Sets the :ref:`Bone2D<class_Bone2D>` node assigned to the Jiggle joint at ``join
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_bone_index** **(** :ref:`int<class_int>` joint_idx, :ref:`int<class_int>` bone_idx **)**
|
||||
|void| **set_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int<class_int>`, bone_idx\: :ref:`int<class_int>`\ )
|
||||
|
||||
Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the Jiggle joint based on data provided by the linked skeleton.
|
||||
|
||||
@@ -394,7 +394,7 @@ Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When po
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_damping** **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` damping **)**
|
||||
|void| **set_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int<class_int>`, damping\: :ref:`float<class_float>`\ )
|
||||
|
||||
Sets the amount of damping of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -406,7 +406,7 @@ Sets the amount of damping of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_gravity** **(** :ref:`int<class_int>` joint_idx, :ref:`Vector2<class_Vector2>` gravity **)**
|
||||
|void| **set_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int<class_int>`, gravity\: :ref:`Vector2<class_Vector2>`\ )
|
||||
|
||||
Sets the gravity vector of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -418,7 +418,7 @@ Sets the gravity vector of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_mass** **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` mass **)**
|
||||
|void| **set_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int<class_int>`, mass\: :ref:`float<class_float>`\ )
|
||||
|
||||
Sets the of mass of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -430,7 +430,7 @@ Sets the of mass of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_override** **(** :ref:`int<class_int>` joint_idx, :ref:`bool<class_bool>` override **)**
|
||||
|void| **set_jiggle_joint_override**\ (\ joint_idx\: :ref:`int<class_int>`, override\: :ref:`bool<class_bool>`\ )
|
||||
|
||||
Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggle joint settings. Setting this to ``true`` will make the joint use its own settings rather than the default ones attached to the modification.
|
||||
|
||||
@@ -442,7 +442,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggl
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_stiffness** **(** :ref:`int<class_int>` joint_idx, :ref:`float<class_float>` stiffness **)**
|
||||
|void| **set_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int<class_int>`, stiffness\: :ref:`float<class_float>`\ )
|
||||
|
||||
Sets the of stiffness of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
@@ -454,7 +454,7 @@ Sets the of stiffness of the Jiggle joint at ``joint_idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_jiggle_joint_use_gravity** **(** :ref:`int<class_int>` joint_idx, :ref:`bool<class_bool>` use_gravity **)**
|
||||
|void| **set_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int<class_int>`, use_gravity\: :ref:`bool<class_bool>`\ )
|
||||
|
||||
Sets whether the Jiggle joint at ``joint_idx`` should use gravity.
|
||||
|
||||
@@ -466,7 +466,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should use gravity.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_use_colliders** **(** :ref:`bool<class_bool>` use_colliders **)**
|
||||
|void| **set_use_colliders**\ (\ use_colliders\: :ref:`bool<class_bool>`\ )
|
||||
|
||||
If ``true``, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects.
|
||||
|
||||
@@ -477,3 +477,4 @@ If ``true``, the Jiggle modifier will take colliders into account, keeping them
|
||||
.. |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.)`
|
||||
|
||||
Reference in New Issue
Block a user