Merge pull request #8446 from godotengine/classref/sync-e38686f

classref: Sync with current master branch (e38686f)
This commit is contained in:
Max Hilbrunner
2023-11-11 04:36:22 +01:00
committed by GitHub
3 changed files with 11 additions and 19 deletions
+4
View File
@@ -742,6 +742,8 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:
\ **Note:** Due to keyboard ghosting, :ref:`is_action_just_pressed<class_Input_method_is_action_just_pressed>` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information.
\ **Note:** During input handling (e.g. :ref:`Node._input<class_Node_private_method__input>`), use :ref:`InputEvent.is_action_pressed<class_InputEvent_method_is_action_pressed>` instead to query the action state of the current event.
.. rst-class:: classref-item-separator
----
@@ -758,6 +760,8 @@ Returns ``true`` when the user *stops* pressing the action event in the current
If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
\ **Note:** During input handling (e.g. :ref:`Node._input<class_Node_private_method__input>`), use :ref:`InputEvent.is_action_released<class_InputEvent_method_is_action_released>` instead to query the action state of the current event.
.. rst-class:: classref-item-separator
----
+1 -1
View File
@@ -1935,7 +1935,7 @@ Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlac
:ref:`SceneTree<class_SceneTree>` **get_tree** **(** **)** |const|
Returns the :ref:`SceneTree<class_SceneTree>` that contains this node.
Returns the :ref:`SceneTree<class_SceneTree>` that contains this node. Returns ``null`` and prints an error if this node is not inside the scene tree. See also :ref:`is_inside_tree<class_Node_method_is_inside_tree>`.
.. rst-class:: classref-item-separator
+6 -18
View File
@@ -493,9 +493,7 @@ Returns the pose transform of the specified bone.
:ref:`Vector3<class_Vector3>` **get_bone_pose_position** **(** :ref:`int<class_int>` bone_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector3<class_Vector3>` is in the local coordinate space of the **Skeleton3D** node.
.. rst-class:: classref-item-separator
@@ -507,9 +505,7 @@ Returns the pose transform of the specified bone.
:ref:`Quaternion<class_Quaternion>` **get_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quaternion<class_Quaternion>` is local to the bone with respect to the rotation of any parent bones.
.. rst-class:: classref-item-separator
@@ -521,9 +517,7 @@ Returns the pose transform of the specified bone.
:ref:`Vector3<class_Vector3>` **get_bone_pose_scale** **(** :ref:`int<class_int>` bone_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns the pose scale of the bone at ``bone_idx``.
.. rst-class:: classref-item-separator
@@ -745,9 +739,7 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If
void **set_bone_pose_position** **(** :ref:`int<class_int>` bone_idx, :ref:`Vector3<class_Vector3>` position **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` is a :ref:`Vector3<class_Vector3>` describing a position local to the **Skeleton3D** node.
.. rst-class:: classref-item-separator
@@ -759,9 +751,7 @@ void **set_bone_pose_position** **(** :ref:`int<class_int>` bone_idx, :ref:`Vect
void **set_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx, :ref:`Quaternion<class_Quaternion>` rotation **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` is a :ref:`Quaternion<class_Quaternion>` describing a rotation in the bone's local coordinate space with respect to the rotation of any parent bones.
.. rst-class:: classref-item-separator
@@ -773,9 +763,7 @@ void **set_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx, :ref:`Quat
void **set_bone_pose_scale** **(** :ref:`int<class_int>` bone_idx, :ref:`Vector3<class_Vector3>` scale **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Sets the pose scale of the bone at ``bone_idx`` to ``scale``.
.. rst-class:: classref-item-separator