mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
Godot Organization
@@ -88,15 +88,15 @@ Methods
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Skeleton3D<class_Skeleton3D>` | :ref:`get_parent_skeleton<class_SkeletonIK3D_method_get_parent_skeleton>` **(** **)** |const| |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_running<class_SkeletonIK3D_method_is_running>` **(** **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`start<class_SkeletonIK3D_method_start>` **(** :ref:`bool<class_bool>` one_time=false **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_SkeletonIK3D_method_stop>` **(** **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Skeleton3D<class_Skeleton3D>` | :ref:`get_parent_skeleton<class_SkeletonIK3D_method_get_parent_skeleton>`\ (\ ) |const| |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_running<class_SkeletonIK3D_method_is_running>`\ (\ ) |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`start<class_SkeletonIK3D_method_start>`\ (\ one_time\: :ref:`bool<class_bool>` = false\ ) |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`stop<class_SkeletonIK3D_method_stop>`\ (\ ) |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
@@ -115,8 +115,8 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_interpolation** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_interpolation** **(** **)**
|
||||
- |void| **set_interpolation**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_interpolation**\ (\ )
|
||||
|
||||
Interpolation value for how much the IK results are applied to the current skeleton bone chain. A value of ``1.0`` will overwrite all skeleton bone transforms completely while a value of ``0.0`` will visually disable the SkeletonIK. A value at or below ``0.01`` also calls :ref:`Skeleton3D.clear_bones_global_pose_override<class_Skeleton3D_method_clear_bones_global_pose_override>`.
|
||||
|
||||
@@ -132,8 +132,8 @@ Interpolation value for how much the IK results are applied to the current skele
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_magnet_position** **(** :ref:`Vector3<class_Vector3>` value **)**
|
||||
- :ref:`Vector3<class_Vector3>` **get_magnet_position** **(** **)**
|
||||
- |void| **set_magnet_position**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
|
||||
- :ref:`Vector3<class_Vector3>` **get_magnet_position**\ (\ )
|
||||
|
||||
Secondary target position (first is :ref:`target<class_SkeletonIK3D_property_target>` property or :ref:`target_node<class_SkeletonIK3D_property_target_node>`) for the IK chain. Use magnet position (pole target) to control the bending of the IK chain. Only works if the bone chain has more than 2 bones. The middle chain bone position will be linearly interpolated with the magnet position.
|
||||
|
||||
@@ -149,8 +149,8 @@ Secondary target position (first is :ref:`target<class_SkeletonIK3D_property_tar
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_max_iterations** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_max_iterations** **(** **)**
|
||||
- |void| **set_max_iterations**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_max_iterations**\ (\ )
|
||||
|
||||
Number of iteration loops used by the IK solver to produce more accurate (and elegant) bone chain results.
|
||||
|
||||
@@ -166,8 +166,8 @@ Number of iteration loops used by the IK solver to produce more accurate (and el
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_min_distance** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_min_distance** **(** **)**
|
||||
- |void| **set_min_distance**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_min_distance**\ (\ )
|
||||
|
||||
The minimum distance between bone and goal target. If the distance is below this value, the IK solver stops further iterations.
|
||||
|
||||
@@ -183,8 +183,8 @@ The minimum distance between bone and goal target. If the distance is below this
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_override_tip_basis** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_override_tip_basis** **(** **)**
|
||||
- |void| **set_override_tip_basis**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_override_tip_basis**\ (\ )
|
||||
|
||||
If ``true`` overwrites the rotation of the tip bone with the rotation of the :ref:`target<class_SkeletonIK3D_property_target>` (or :ref:`target_node<class_SkeletonIK3D_property_target_node>` if defined).
|
||||
|
||||
@@ -200,8 +200,8 @@ If ``true`` overwrites the rotation of the tip bone with the rotation of the :re
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_root_bone** **(** :ref:`StringName<class_StringName>` value **)**
|
||||
- :ref:`StringName<class_StringName>` **get_root_bone** **(** **)**
|
||||
- |void| **set_root_bone**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||||
- :ref:`StringName<class_StringName>` **get_root_bone**\ (\ )
|
||||
|
||||
The name of the current root bone, the first bone in the IK chain.
|
||||
|
||||
@@ -217,8 +217,8 @@ The name of the current root bone, the first bone in the IK chain.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_target_transform** **(** :ref:`Transform3D<class_Transform3D>` value **)**
|
||||
- :ref:`Transform3D<class_Transform3D>` **get_target_transform** **(** **)**
|
||||
- |void| **set_target_transform**\ (\ value\: :ref:`Transform3D<class_Transform3D>`\ )
|
||||
- :ref:`Transform3D<class_Transform3D>` **get_target_transform**\ (\ )
|
||||
|
||||
First target of the IK chain where the tip bone is placed and, if :ref:`override_tip_basis<class_SkeletonIK3D_property_override_tip_basis>` is ``true``, how the tip bone is rotated. If a :ref:`target_node<class_SkeletonIK3D_property_target_node>` path is available the nodes transform is used instead and this property is ignored.
|
||||
|
||||
@@ -234,8 +234,8 @@ First target of the IK chain where the tip bone is placed and, if :ref:`override
|
||||
|
||||
.. 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**\ (\ )
|
||||
|
||||
Target node :ref:`NodePath<class_NodePath>` for the IK chain. If available, the node's current :ref:`Transform3D<class_Transform3D>` is used instead of the :ref:`target<class_SkeletonIK3D_property_target>` property.
|
||||
|
||||
@@ -251,8 +251,8 @@ Target node :ref:`NodePath<class_NodePath>` for the IK chain. If available, the
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_tip_bone** **(** :ref:`StringName<class_StringName>` value **)**
|
||||
- :ref:`StringName<class_StringName>` **get_tip_bone** **(** **)**
|
||||
- |void| **set_tip_bone**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||||
- :ref:`StringName<class_StringName>` **get_tip_bone**\ (\ )
|
||||
|
||||
The name of the current tip bone, the last bone in the IK chain placed at the :ref:`target<class_SkeletonIK3D_property_target>` transform (or :ref:`target_node<class_SkeletonIK3D_property_target_node>` if defined).
|
||||
|
||||
@@ -268,8 +268,8 @@ The name of the current tip bone, the last bone in the IK chain placed at the :r
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_use_magnet** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_using_magnet** **(** **)**
|
||||
- |void| **set_use_magnet**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_using_magnet**\ (\ )
|
||||
|
||||
If ``true``, instructs the IK solver to consider the secondary magnet target (pole target) when calculating the bone chain. Use the magnet position (pole target) to control the bending of the IK chain.
|
||||
|
||||
@@ -286,7 +286,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Skeleton3D<class_Skeleton3D>` **get_parent_skeleton** **(** **)** |const|
|
||||
:ref:`Skeleton3D<class_Skeleton3D>` **get_parent_skeleton**\ (\ ) |const|
|
||||
|
||||
Returns the parent :ref:`Skeleton3D<class_Skeleton3D>` Node that was present when SkeletonIK entered the :ref:`SceneTree<class_SceneTree>`. Returns null if the parent node was not a :ref:`Skeleton3D<class_Skeleton3D>` Node when SkeletonIK3D entered the :ref:`SceneTree<class_SceneTree>`.
|
||||
|
||||
@@ -298,7 +298,7 @@ Returns the parent :ref:`Skeleton3D<class_Skeleton3D>` Node that was present whe
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_running** **(** **)**
|
||||
:ref:`bool<class_bool>` **is_running**\ (\ )
|
||||
|
||||
Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the :ref:`Skeleton3D<class_Skeleton3D>` bones. Returns ``false`` if SkeletonIK is stopped or :ref:`start<class_SkeletonIK3D_method_start>` was used with the ``one_time`` parameter set to ``true``.
|
||||
|
||||
@@ -310,7 +310,7 @@ Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **start** **(** :ref:`bool<class_bool>` one_time=false **)**
|
||||
|void| **start**\ (\ one_time\: :ref:`bool<class_bool>` = false\ )
|
||||
|
||||
Starts applying IK effects on each frame to the :ref:`Skeleton3D<class_Skeleton3D>` bones but will only take effect starting on the next frame. If ``one_time`` is ``true``, this will take effect immediately but also reset on the next frame.
|
||||
|
||||
@@ -322,7 +322,7 @@ Starts applying IK effects on each frame to the :ref:`Skeleton3D<class_Skeleton3
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **stop** **(** **)**
|
||||
|void| **stop**\ (\ )
|
||||
|
||||
Stops applying IK effects on each frame to the :ref:`Skeleton3D<class_Skeleton3D>` bones and also calls :ref:`Skeleton3D.clear_bones_global_pose_override<class_Skeleton3D_method_clear_bones_global_pose_override>` to remove existing overrides on all bones.
|
||||
|
||||
@@ -333,3 +333,4 @@ Stops applying IK effects on each frame to the :ref:`Skeleton3D<class_Skeleton3D
|
||||
.. |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