Skip to content

Commit 9212f4f

Browse files
authored
Merge pull request #8446 from godotengine/classref/sync-e38686f
classref: Sync with current master branch (e38686f)
2 parents 6981d93 + 877192f commit 9212f4f

File tree

3 files changed

+11
-19
lines changed

3 files changed

+11
-19
lines changed

classes/class_input.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -742,6 +742,8 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:
742742

743743
\ **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.
744744

745+
\ **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.
746+
745747
.. rst-class:: classref-item-separator
746748

747749
----
@@ -758,6 +760,8 @@ Returns ``true`` when the user *stops* pressing the action event in the current
758760

759761
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.
760762

763+
\ **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.
764+
761765
.. rst-class:: classref-item-separator
762766

763767
----

classes/class_node.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1935,7 +1935,7 @@ Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlac
19351935

19361936
:ref:`SceneTree<class_SceneTree>` **get_tree** **(** **)** |const|
19371937

1938-
Returns the :ref:`SceneTree<class_SceneTree>` that contains this node.
1938+
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>`.
19391939

19401940
.. rst-class:: classref-item-separator
19411941

classes/class_skeleton3d.rst

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -493,9 +493,7 @@ Returns the pose transform of the specified bone.
493493

494494
:ref:`Vector3<class_Vector3>` **get_bone_pose_position** **(** :ref:`int<class_int>` bone_idx **)** |const|
495495

496-
.. container:: contribute
497-
498-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
496+
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.
499497

500498
.. rst-class:: classref-item-separator
501499

@@ -507,9 +505,7 @@ Returns the pose transform of the specified bone.
507505

508506
:ref:`Quaternion<class_Quaternion>` **get_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx **)** |const|
509507

510-
.. container:: contribute
511-
512-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
508+
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.
513509

514510
.. rst-class:: classref-item-separator
515511

@@ -521,9 +517,7 @@ Returns the pose transform of the specified bone.
521517

522518
:ref:`Vector3<class_Vector3>` **get_bone_pose_scale** **(** :ref:`int<class_int>` bone_idx **)** |const|
523519

524-
.. container:: contribute
525-
526-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
520+
Returns the pose scale of the bone at ``bone_idx``.
527521

528522
.. rst-class:: classref-item-separator
529523

@@ -745,9 +739,7 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If
745739

746740
void **set_bone_pose_position** **(** :ref:`int<class_int>` bone_idx, :ref:`Vector3<class_Vector3>` position **)**
747741

748-
.. container:: contribute
749-
750-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
742+
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.
751743

752744
.. rst-class:: classref-item-separator
753745

@@ -759,9 +751,7 @@ void **set_bone_pose_position** **(** :ref:`int<class_int>` bone_idx, :ref:`Vect
759751

760752
void **set_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx, :ref:`Quaternion<class_Quaternion>` rotation **)**
761753

762-
.. container:: contribute
763-
764-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
754+
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.
765755

766756
.. rst-class:: classref-item-separator
767757

@@ -773,9 +763,7 @@ void **set_bone_pose_rotation** **(** :ref:`int<class_int>` bone_idx, :ref:`Quat
773763

774764
void **set_bone_pose_scale** **(** :ref:`int<class_int>` bone_idx, :ref:`Vector3<class_Vector3>` scale **)**
775765

776-
.. container:: contribute
777-
778-
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
766+
Sets the pose scale of the bone at ``bone_idx`` to ``scale``.
779767

780768
.. rst-class:: classref-item-separator
781769

0 commit comments

Comments
 (0)