From 388e6b7328e75f020747fb0ba0bedcabc71aeaa1 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 6 Apr 2024 03:20:11 +0000 Subject: [PATCH] classref: Sync with current master branch (655e93d) --- classes/class_animationmixer.rst | 20 +- classes/class_astar2d.rst | 14 +- classes/class_astar3d.rst | 14 +- classes/class_astargrid2d.rst | 76 +- classes/class_boneattachment3d.rst | 2 + classes/class_collisionobject3d.rst | 102 +-- classes/class_editorfiledialog.rst | 159 +++- classes/class_editorsettings.rst | 28 + classes/class_filedialog.rst | 64 +- classes/class_geometryinstance3d.rst | 4 +- classes/class_graphedit.rst | 86 +- classes/class_graphelement.rst | 18 +- classes/class_graphframe.rst | 299 +++++++ classes/class_heightmapshape3d.rst | 46 +- classes/class_node.rst | 8 +- classes/class_node2d.rst | 2 +- classes/class_node3d.rst | 2 +- classes/class_openxrcompositionlayer.rst | 142 ++++ .../class_openxrcompositionlayercylinder.rst | 122 +++ .../class_openxrcompositionlayerequirect.rst | 141 ++++ ...t => class_openxrcompositionlayerquad.rst} | 34 +- classes/class_openxrhand.rst | 41 +- classes/class_physicalbonesimulator3d.rst | 122 +++ classes/class_projectsettings.rst | 14 + classes/class_renderingserver.rst | 16 + classes/class_skeleton3d.rst | 153 +++- classes/class_skeletonik3d.rst | 29 +- classes/class_skeletonmodifier3d.rst | 109 +++ classes/class_skeletonprofile.rst | 30 + classes/class_statusindicator.rst | 2 +- classes/class_textedit.rst | 2 + classes/class_textserver.rst | 18 + classes/class_textserverextension.rst | 16 + classes/class_tilemap.rst | 35 +- classes/class_tilemaplayer.rst | 761 ++++++++++++++++++ classes/class_tree.rst | 4 +- classes/class_variant.rst | 4 +- classes/class_visualshader.rst | 28 + classes/class_visualshadernode.rst | 25 +- classes/class_visualshadernodecomment.rst | 84 -- classes/class_visualshadernodeframe.rst | 188 +++++ .../class_visualshadernoderesizablebase.rst | 2 +- classes/class_xrbodymodifier3d.rst | 21 +- classes/class_xrhandmodifier3d.rst | 21 +- classes/index.rst | 11 +- 45 files changed, 2725 insertions(+), 394 deletions(-) create mode 100644 classes/class_graphframe.rst create mode 100644 classes/class_openxrcompositionlayer.rst create mode 100644 classes/class_openxrcompositionlayercylinder.rst create mode 100644 classes/class_openxrcompositionlayerequirect.rst rename classes/{class_tilemaplayergroup.rst => class_openxrcompositionlayerquad.rst} (57%) create mode 100644 classes/class_physicalbonesimulator3d.rst create mode 100644 classes/class_skeletonmodifier3d.rst create mode 100644 classes/class_tilemaplayer.rst delete mode 100644 classes/class_visualshadernodecomment.rst create mode 100644 classes/class_visualshadernodeframe.rst diff --git a/classes/class_animationmixer.rst b/classes/class_animationmixer.rst index 11bd9505e..8db5dde50 100644 --- a/classes/class_animationmixer.rst +++ b/classes/class_animationmixer.rst @@ -176,13 +176,25 @@ Notifies when the caches have been cleared, either automatically, or manually vi ---- +.. _class_AnimationMixer_signal_mixer_applied: + +.. rst-class:: classref-signal + +**mixer_applied**\ (\ ) + +Notifies when the blending result related have been applied to the target objects. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationMixer_signal_mixer_updated: .. rst-class:: classref-signal **mixer_updated**\ (\ ) -Editor only. Notifies when the property have been updated to update dummy :ref:`AnimationPlayer` in animation player editor. +Notifies when the property related process have been updated. .. rst-class:: classref-section-separator @@ -580,7 +592,7 @@ Returns the :ref:`Animation` with the key ``name``. If the anim Returns the first :ref:`AnimationLibrary` with key ``name`` or ``null`` if not found. -To get the :ref:`AnimationPlayer`'s global animation library, use ``get_animation_library("")``. +To get the **AnimationMixer**'s global animation library, use ``get_animation_library("")``. .. rst-class:: classref-item-separator @@ -839,7 +851,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi :ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| -Returns ``true`` if the :ref:`AnimationPlayer` stores an :ref:`Animation` with key ``name``. +Returns ``true`` if the **AnimationMixer** stores an :ref:`Animation` with key ``name``. .. rst-class:: classref-item-separator @@ -851,7 +863,7 @@ Returns ``true`` if the :ref:`AnimationPlayer` stores an :ref:`bool` **has_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| -Returns ``true`` if the :ref:`AnimationPlayer` stores an :ref:`AnimationLibrary` with key ``name``. +Returns ``true`` if the **AnimationMixer** stores an :ref:`AnimationLibrary` with key ``name``. .. rst-class:: classref-item-separator diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 0692f720d..4e4faea58 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -52,7 +52,7 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_closest_position_in_segment`\ (\ to_position\: :ref:`Vector2`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_capacity`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`get_point_ids`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_point_position`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -283,10 +283,12 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + .. tabs:: @@ -410,11 +412,13 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. -\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector2Array` and will print an error message. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + +\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty array and will print an error message. .. rst-class:: classref-item-separator diff --git a/classes/class_astar3d.rst b/classes/class_astar3d.rst index 8dbfca024..6f23f7ddb 100644 --- a/classes/class_astar3d.rst +++ b/classes/class_astar3d.rst @@ -89,7 +89,7 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_closest_position_in_segment`\ (\ to_position\: :ref:`Vector3`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_capacity`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,7 +99,7 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`get_point_ids`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + | :ref:`PackedVector3Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_point_position`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -320,10 +320,12 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + .. tabs:: @@ -445,11 +447,13 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) +:ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. -\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector3Array` and will print an error message. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + +\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty array and will print an error message. .. rst-class:: classref-item-separator diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index 5b9a394fb..fe0434c38 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -84,39 +84,39 @@ Methods .. table:: :widths: auto - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_compute_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill_solid_region`\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill_weight_scale_region`\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_id_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position`\ (\ id\: :ref:`Vector2i`\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_weight_scale`\ (\ id\: :ref:`Vector2i`\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dirty`\ (\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_bounds`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_boundsv`\ (\ id\: :ref:`Vector2i`\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_solid`\ (\ id\: :ref:`Vector2i`\ ) |const| | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_point_solid`\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_point_weight_scale`\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`update`\ (\ ) | - +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_compute_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill_solid_region`\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill_weight_scale_region`\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_id_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_weight_scale`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dirty`\ (\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_bounds`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_boundsv`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_solid`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_solid`\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_weight_scale`\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update`\ (\ ) | + +--------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -537,10 +537,12 @@ Fills the given ``region`` on the grid with the specified value for the weight s .. rst-class:: classref-method -:ref:`Array`\[:ref:`Vector2i`\] **get_id_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) +:ref:`Array`\[:ref:`Vector2i`\] **get_id_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + .. rst-class:: classref-item-separator ---- @@ -549,11 +551,13 @@ Returns an array with the IDs of the points that form the path found by AStar2D .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`, allow_partial_path\: :ref:`bool` = false\ ) Returns an array with the points that are in the path found by **AStarGrid2D** between the given points. The array is ordered from the starting point to the ending point of the path. -\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector3Array` and will print an error message. +If there is no valid path to the target, and ``allow_partial_path`` is ``true``, returns a path to the point closest to the target that can be reached. + +\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty array and will print an error message. .. rst-class:: classref-item-separator diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 727d5ac06..8d6c0007c 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -116,6 +116,8 @@ The name of the attached bone. Whether the BoneAttachment3D node will override the bone pose of the bone it is attached to. When set to ``true``, the BoneAttachment3D node can change the pose of the bone. When set to ``false``, the BoneAttachment3D will always be set to the bone's transform. +\ **Note:** This override performs interruptively in the skeleton update process using signals due to the old design. It may cause unintended behavior when used at the same time with :ref:`SkeletonModifier3D`. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_collisionobject3d.rst b/classes/class_collisionobject3d.rst index 06e2beb1c..87d18e263 100644 --- a/classes/class_collisionobject3d.rst +++ b/classes/class_collisionobject3d.rst @@ -55,53 +55,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_input_event`\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_mouse_enter`\ (\ ) |virtual| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_mouse_exit`\ (\ ) |virtual| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_shape_owner`\ (\ owner\: :ref:`Object`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_shape_owners`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_shape_owner_disabled`\ (\ owner_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_shape_owner`\ (\ owner_id\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_find_owner`\ (\ shape_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shape_owner_add_shape`\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shape_owner_clear_shapes`\ (\ owner_id\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`shape_owner_get_owner`\ (\ owner_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shape3D` | :ref:`shape_owner_get_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_count`\ (\ owner_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_index`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`shape_owner_get_transform`\ (\ owner_id\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shape_owner_remove_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shape_owner_set_disabled`\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`shape_owner_set_transform`\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_input_event`\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_enter`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_exit`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_shape_owner`\ (\ owner\: :ref:`Object`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_shape_owners`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_shape_owner_disabled`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_shape_owner`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_find_owner`\ (\ shape_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_add_shape`\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_clear_shapes`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`shape_owner_get_owner`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shape3D` | :ref:`shape_owner_get_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_count`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_index`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`shape_owner_get_transform`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_remove_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_disabled`\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_transform`\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,9 +116,9 @@ Signals .. rst-class:: classref-signal -**input_event**\ (\ camera\: :ref:`Node`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) +**input_event**\ (\ camera\: :ref:`Node`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) -Emitted when the object receives an unhandled :ref:`InputEvent`. ``position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. +Emitted when the object receives an unhandled :ref:`InputEvent`. ``event_position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. .. rst-class:: classref-item-separator @@ -315,9 +315,9 @@ Method Descriptions .. rst-class:: classref-method -|void| **_input_event**\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| +|void| **_input_event**\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, event_position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| -Receives unhandled :ref:`InputEvent`\ s. ``position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. Connect to the :ref:`input_event` signal to easily pick up these events. +Receives unhandled :ref:`InputEvent`\ s. ``event_position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. Connect to the :ref:`input_event` signal to easily pick up these events. \ **Note:** :ref:`_input_event` requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 6ffd062b7..45b3e54d4 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -48,6 +48,8 @@ Properties +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`option_count` | ``0`` | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | @@ -61,19 +63,35 @@ Methods .. table:: :widths: auto - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_filters`\ (\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`invalidate`\ (\ ) | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_filters`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`invalidate`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -376,6 +394,23 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd ---- +.. _class_EditorFileDialog_property_option_count: + +.. rst-class:: classref-property + +:ref:`int` **option_count** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_option_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_option_count**\ (\ ) + +The number of additional :ref:`OptionButton`\ s and :ref:`CheckBox`\ es in the dialog. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorFileDialog_property_show_hidden_files: .. rst-class:: classref-property @@ -414,6 +449,20 @@ For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Sce ---- +.. _class_EditorFileDialog_method_add_option: + +.. rst-class:: classref-method + +|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) + +Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. + +\ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked). + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorFileDialog_method_add_side_menu: .. rst-class:: classref-method @@ -452,6 +501,54 @@ Returns the LineEdit for the selected file. ---- +.. _class_EditorFileDialog_method_get_option_default: + +.. rst-class:: classref-method + +:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| + +Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_get_option_name: + +.. rst-class:: classref-method + +:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| + +Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_get_option_values: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| + +Returns an array of values of the :ref:`OptionButton` with index ``option``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_get_selected_options: + +.. rst-class:: classref-method + +:ref:`Dictionary` **get_selected_options**\ (\ ) |const| + +Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorFileDialog_method_get_vbox: .. rst-class:: classref-method @@ -474,6 +571,42 @@ Returns the :ref:`VBoxContainer` used to display the file s Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update. +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_set_option_default: + +.. rst-class:: classref-method + +|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) + +Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_set_option_name: + +.. rst-class:: classref-method + +|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) + +Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorFileDialog_method_set_option_values: + +.. rst-class:: classref-method + +|void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) + +Sets the option values of the :ref:`OptionButton` with index ``option``. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 6ea722ab0..ade1a3f94 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -221,6 +221,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/tiles_editor/grid_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/tiles_editor/highlight_selected_layer` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/visual_editors/category_colors/color_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/visual_editors/category_colors/conditional_color` | @@ -369,6 +371,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/use_native_file_dialogs` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/vsync_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | @@ -1781,6 +1785,18 @@ The color to use for the TileMap editor's grid. ---- +.. _class_EditorSettings_property_editors/tiles_editor/highlight_selected_layer: + +.. rst-class:: classref-property + +:ref:`bool` **editors/tiles_editor/highlight_selected_layer** + +Highlight the currently selected TileMapLayer by dimming the other ones in the scene. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/visual_editors/category_colors/color_color: .. rst-class:: classref-property @@ -2757,6 +2773,18 @@ Specific to the macOS platform. ---- +.. _class_EditorSettings_property_interface/editor/use_native_file_dialogs: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/use_native_file_dialogs** + +If ``true``, editor UI uses OS native file/directory selection dialogs. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/vsync_mode: .. rst-class:: classref-property diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 59afc6ef7..25c3396ac 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -65,35 +65,35 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, index\: :ref:`int`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_filters`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect_all`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`invalidate`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, index\: :ref:`int`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_filters`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect_all`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`invalidate`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -482,10 +482,12 @@ For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Imag .. rst-class:: classref-method -|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, index\: :ref:`int`\ ) +|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. +\ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked). + .. rst-class:: classref-item-separator ---- @@ -606,7 +608,7 @@ Invalidate and update the current dialog content list. .. rst-class:: classref-method -|void| **set_option_default**\ (\ option\: :ref:`int`, index\: :ref:`int`\ ) +|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 5a175c580..b0e32a731 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -153,7 +153,7 @@ enum **GIMode**: :ref:`GIMode` **GI_MODE_DISABLED** = ``0`` -Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using :ref:`VoxelGI` and SDFGI, the geometry will *receive* indirect lighting and reflections but the geometry will not be considered in GI baking. When using :ref:`LightmapGI`, the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture. +Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using :ref:`VoxelGI` and SDFGI, the geometry will *receive* indirect lighting and reflections but the geometry will not be considered in GI baking. .. _class_GeometryInstance3D_constant_GI_MODE_STATIC: @@ -169,7 +169,7 @@ Baked global illumination mode. Use for static objects that contribute to global :ref:`GIMode` **GI_MODE_DYNAMIC** = ``2`` -Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using :ref:`VoxelGI`, but it has a higher performance impact than :ref:`GI_MODE_STATIC`. When using other GI methods, this will act the same as :ref:`GI_MODE_DISABLED`. +Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using :ref:`VoxelGI`, but it has a higher performance impact than :ref:`GI_MODE_STATIC`. When using other GI methods, this will act the same as :ref:`GI_MODE_DISABLED`. When using :ref:`LightmapGI`, the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture. .. rst-class:: classref-item-separator diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index a69497313..b246d64ef 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -112,14 +112,20 @@ Methods +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`arrange_nodes`\ (\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`attach_graph_element_to_frame`\ (\ element\: :ref:`StringName`, frame\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_connections`\ (\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_node`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`detach_graph_element_from_frame`\ (\ element\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_node`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_connection_drag_end`\ (\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_attached_nodes_of_frame`\ (\ frame\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_closest_connection_at_point`\ (\ point\: :ref:`Vector2`, max_distance\: :ref:`float` = 4.0\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_connection_line`\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| | @@ -128,6 +134,8 @@ Methods +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connections_intersecting_with_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GraphFrame` | :ref:`get_element_frame`\ (\ element\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HBoxContainer` | :ref:`get_menu_hbox`\ (\ ) | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connected`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | @@ -336,6 +344,32 @@ Emitted at the end of a :ref:`GraphElement`'s movement. ---- +.. _class_GraphEdit_signal_frame_rect_changed: + +.. rst-class:: classref-signal + +**frame_rect_changed**\ (\ frame\: :ref:`GraphFrame`, new_rect\: :ref:`Vector2`\ ) + +Emitted when the :ref:`GraphFrame` ``frame`` is resized to ``new_rect``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphEdit_signal_graph_elements_linked_to_frame_request: + +.. rst-class:: classref-signal + +**graph_elements_linked_to_frame_request**\ (\ elements\: :ref:`Array`, frame\: :ref:`StringName`\ ) + +Emitted when one or more :ref:`GraphElement`\ s are dropped onto the :ref:`GraphFrame` named ``frame``, when they were not previously attached to any other one. + +\ ``elements`` is an array of :ref:`GraphElement`\ s to be attached. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_signal_node_deselected: .. rst-class:: classref-signal @@ -376,9 +410,9 @@ Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` .. rst-class:: classref-signal -**popup_request**\ (\ position\: :ref:`Vector2`\ ) +**popup_request**\ (\ at_position\: :ref:`Vector2`\ ) -Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``position`` is the position of the mouse pointer when the signal is sent. +Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``at_position`` is the position of the mouse pointer when the signal is sent. .. rst-class:: classref-item-separator @@ -997,6 +1031,18 @@ Rearranges selected nodes in a layout with minimum crossings between connections ---- +.. _class_GraphEdit_method_attach_graph_element_to_frame: + +.. rst-class:: classref-method + +|void| **attach_graph_element_to_frame**\ (\ element\: :ref:`StringName`, frame\: :ref:`StringName`\ ) + +Attaches the ``element`` :ref:`GraphElement` to the ``frame`` :ref:`GraphFrame`. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_clear_connections: .. rst-class:: classref-method @@ -1021,6 +1067,18 @@ Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNo ---- +.. _class_GraphEdit_method_detach_graph_element_from_frame: + +.. rst-class:: classref-method + +|void| **detach_graph_element_from_frame**\ (\ element\: :ref:`StringName`\ ) + +Detaches the ``element`` :ref:`GraphElement` from the :ref:`GraphFrame` it is currently attached to. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_disconnect_node: .. rst-class:: classref-method @@ -1049,6 +1107,18 @@ This is best used together with :ref:`connection_drag_started`\[:ref:`StringName`\] **get_attached_nodes_of_frame**\ (\ frame\: :ref:`StringName`\ ) + +Returns an array of node names that are attached to the :ref:`GraphFrame` with the given name. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_get_closest_connection_at_point: .. rst-class:: classref-method @@ -1110,6 +1180,18 @@ Returns an :ref:`Array` containing the list of connections that int ---- +.. _class_GraphEdit_method_get_element_frame: + +.. rst-class:: classref-method + +:ref:`GraphFrame` **get_element_frame**\ (\ element\: :ref:`StringName`\ ) + +Returns the :ref:`GraphFrame` that contains the :ref:`GraphElement` with the given name. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_get_menu_hbox: .. rst-class:: classref-method diff --git a/classes/class_graphelement.rst b/classes/class_graphelement.rst index 343daae09..3e8f26909 100644 --- a/classes/class_graphelement.rst +++ b/classes/class_graphelement.rst @@ -14,7 +14,7 @@ GraphElement **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`GraphNode` +**Inherited By:** :ref:`GraphFrame`, :ref:`GraphNode` A container that represents a basic element that can be placed inside a :ref:`GraphEdit` control. @@ -138,11 +138,23 @@ Emitted when displaying the GraphElement over other ones is requested. Happens o ---- +.. _class_GraphElement_signal_resize_end: + +.. rst-class:: classref-signal + +**resize_end**\ (\ new_size\: :ref:`Vector2`\ ) + +Emitted when releasing the mouse button after dragging the resizer handle (see :ref:`resizable`). + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphElement_signal_resize_request: .. rst-class:: classref-signal -**resize_request**\ (\ new_minsize\: :ref:`Vector2`\ ) +**resize_request**\ (\ new_size\: :ref:`Vector2`\ ) Emitted when resizing the GraphElement is requested. Happens on dragging the resizer handle (see :ref:`resizable`). @@ -202,7 +214,7 @@ The offset of the GraphElement, relative to the scroll offset of the :ref:`Graph If ``true``, the user can resize the GraphElement. -\ **Note:** Dragging the handle will only emit the :ref:`resize_request` signal, the GraphElement needs to be resized manually. +\ **Note:** Dragging the handle will only emit the :ref:`resize_request` and :ref:`resize_end` signals, the GraphElement needs to be resized manually. .. rst-class:: classref-item-separator diff --git a/classes/class_graphframe.rst b/classes/class_graphframe.rst new file mode 100644 index 000000000..97e28160b --- /dev/null +++ b/classes/class_graphframe.rst @@ -0,0 +1,299 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphFrame.xml. + +.. _class_GraphFrame: + +GraphFrame +========== + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`GraphElement` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +GraphFrame is a special :ref:`GraphElement` that can be used to organize other :ref:`GraphElement`\ s inside a :ref:`GraphEdit`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +GraphFrame is a special :ref:`GraphElement` to which other :ref:`GraphElement`\ s can be attached. It can be configured to automatically resize to enclose all attached :ref:`GraphElement`\ s. If the frame is moved, all the attached :ref:`GraphElement`\ s inside it will be moved as well. + +A GraphFrame is always kept behind the connection layer and other :ref:`GraphElement`\ s inside a :ref:`GraphEdit`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`bool` | :ref:`autoshrink_enabled` | ``true`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`int` | :ref:`autoshrink_margin` | ``40`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`int` | :ref:`drag_margin` | ``16`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`Color` | :ref:`tint_color` | ``Color(0.3, 0.3, 0.3, 0.75)`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tint_color_enabled` | ``false`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`title` | ``""`` | + +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`HBoxContainer` | :ref:`get_titlebar_hbox`\ (\ ) | + +-------------------------------------------+---------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`resizer_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel` | | + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel_selected` | | + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`titlebar` | | + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`titlebar_selected` | | + +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_GraphFrame_signal_autoshrink_changed: + +.. rst-class:: classref-signal + +**autoshrink_changed**\ (\ ) + +Emitted when :ref:`autoshrink_enabled` or :ref:`autoshrink_margin` changes. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_GraphFrame_property_autoshrink_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **autoshrink_enabled** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_autoshrink_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_autoshrink_enabled**\ (\ ) + +If ``true``, the frame's rect will be adjusted automatically to enclose all attached :ref:`GraphElement`\ s. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_property_autoshrink_margin: + +.. rst-class:: classref-property + +:ref:`int` **autoshrink_margin** = ``40`` + +.. rst-class:: classref-property-setget + +- |void| **set_autoshrink_margin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_autoshrink_margin**\ (\ ) + +The margin around the attached nodes that is used to calculate the size of the frame when :ref:`autoshrink_enabled` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_property_drag_margin: + +.. rst-class:: classref-property + +:ref:`int` **drag_margin** = ``16`` + +.. rst-class:: classref-property-setget + +- |void| **set_drag_margin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_drag_margin**\ (\ ) + +The margin inside the frame that can be used to drag the frame. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_property_tint_color: + +.. rst-class:: classref-property + +:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` + +.. rst-class:: classref-property-setget + +- |void| **set_tint_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_tint_color**\ (\ ) + +The color of the frame when :ref:`tint_color_enabled` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_property_tint_color_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **tint_color_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_tint_color_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_tint_color_enabled**\ (\ ) + +If ``true``, the tint color will be used to tint the frame. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_property_title: + +.. rst-class:: classref-property + +:ref:`String` **title** = ``""`` + +.. rst-class:: classref-property-setget + +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) + +Title of the frame. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GraphFrame_method_get_titlebar_hbox: + +.. rst-class:: classref-method + +:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) + +Returns the :ref:`HBoxContainer` used for the title bar, only containing a :ref:`Label` for displaying the title by default. + +This can be used to add custom controls to the title bar such as option or close buttons. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_GraphFrame_theme_color_resizer_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` + +The color modulation applied to the resizer icon. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_theme_style_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel** + +The default :ref:`StyleBox` used for the background of the **GraphFrame**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_theme_style_panel_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel_selected** + +The :ref:`StyleBox` used for the background of the **GraphFrame** when it is selected. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_theme_style_titlebar: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **titlebar** + +The :ref:`StyleBox` used for the title bar of the **GraphFrame**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphFrame_theme_style_titlebar_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **titlebar_selected** + +The :ref:`StyleBox` used for the title bar of the **GraphFrame** when it is selected. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index a65093804..bd507b0dd 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -23,6 +23,24 @@ A 3D heightmap shape, intended for use in physics. Usually used to provide a sha \ **Performance:** **HeightMapShape3D** is faster to check collisions against than :ref:`ConcavePolygonShape3D`, but it is significantly slower than primitive shapes like :ref:`BoxShape3D`. +A heightmap collision shape can also be build by using an :ref:`Image` reference: + + +.. tabs:: + + .. code-tab:: gdscript + + var heightmap_texture: Texture = ResourceLoader.load("res://heightmap_image.exr") + var heightmap_image: Image = heightmap_texture.get_image() + heightmap_image.convert(Image.FORMAT_RF) + + var height_min: float = 0.0 + var height_max: float = 10.0 + + update_map_data_from_image(heightmap_image, height_min, height_max) + + + .. rst-class:: classref-reftable-group Properties @@ -47,11 +65,13 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_max_height`\ (\ ) |const| | - +---------------------------+-----------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_min_height`\ (\ ) |const| | - +---------------------------+-----------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_max_height`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_min_height`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_map_data_from_image`\ (\ image\: :ref:`Image`, height_min\: :ref:`float`, height_max\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -138,6 +158,22 @@ Returns the largest height value found in :ref:`map_data`. Recalculates only when :ref:`map_data` changes. +.. rst-class:: classref-item-separator + +---- + +.. _class_HeightMapShape3D_method_update_map_data_from_image: + +.. rst-class:: classref-method + +|void| **update_map_data_from_image**\ (\ image\: :ref:`Image`, height_min\: :ref:`float`, height_max\: :ref:`float`\ ) + +Updates :ref:`map_data` with data read from an :ref:`Image` reference. Automatically resizes heightmap :ref:`map_width` and :ref:`map_depth` to fit the full image width and height. + +The image needs to be in either :ref:`Image.FORMAT_RF` (32 bit), :ref:`Image.FORMAT_RH` (16 bit), or :ref:`Image.FORMAT_R8` (8 bit). + +Each image pixel is read in as a float on the range from ``0.0`` (black pixel) to ``1.0`` (white pixel). This range value gets remapped to ``height_min`` and ``height_max`` to form the final height value. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_node.rst b/classes/class_node.rst index 623adc0e6..ae0a57df8 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -12,7 +12,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AnimationMixer`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`MissingNode`, :ref:`MultiplayerSpawner`, :ref:`MultiplayerSynchronizer`, :ref:`NavigationAgent2D`, :ref:`NavigationAgent3D`, :ref:`Node3D`, :ref:`ResourcePreloader`, :ref:`ShaderGlobalsOverride`, :ref:`SkeletonIK3D`, :ref:`StatusIndicator`, :ref:`Timer`, :ref:`Viewport`, :ref:`WorldEnvironment` +**Inherited By:** :ref:`AnimationMixer`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`MissingNode`, :ref:`MultiplayerSpawner`, :ref:`MultiplayerSynchronizer`, :ref:`NavigationAgent2D`, :ref:`NavigationAgent3D`, :ref:`Node3D`, :ref:`ResourcePreloader`, :ref:`ShaderGlobalsOverride`, :ref:`StatusIndicator`, :ref:`Timer`, :ref:`Viewport`, :ref:`WorldEnvironment` Base class for all scene objects. @@ -253,7 +253,7 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reparent`\ (\ new_parent\: :ref:`Node`, keep_global_transform\: :ref:`bool` = true\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`replace_by`\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) | + | |void| | :ref:`replace_by`\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false, keep_children\: :ref:`bool` = true\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`request_ready`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2685,9 +2685,9 @@ If ``keep_global_transform`` is ``true``, the node's global transform will be pr .. rst-class:: classref-method -|void| **replace_by**\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) +|void| **replace_by**\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false, keep_children\: :ref:`bool` = true\ ) -Replaces this node by the given ``node``. All children of this node are moved to ``node``. +Replaces this node by the given ``node``. If ``keep_children`` is ``true`` all children of this node are moved to ``node``. If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that the replaced node is in (see :ref:`add_to_group`). diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 4bd7e2475..89387e742 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -12,7 +12,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`CPUParticles2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`Marker2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationLink2D`, :ref:`NavigationObstacle2D`, :ref:`NavigationRegion2D`, :ref:`Parallax2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`ShapeCast2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMapLayerGroup`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` +**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`CPUParticles2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`Marker2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationLink2D`, :ref:`NavigationObstacle2D`, :ref:`NavigationRegion2D`, :ref:`Parallax2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`ShapeCast2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMap`, :ref:`TileMapLayer`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index. diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index 9a82900d9..4d1545d04 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -12,7 +12,7 @@ Node3D **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRBodyModifier3D`, :ref:`XRFaceModifier3D`, :ref:`XRHandModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` +**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`OpenXRCompositionLayer`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` Most basic 3D game object, parent of all 3D-related nodes. diff --git a/classes/class_openxrcompositionlayer.rst b/classes/class_openxrcompositionlayer.rst new file mode 100644 index 000000000..ab30aab90 --- /dev/null +++ b/classes/class_openxrcompositionlayer.rst @@ -0,0 +1,142 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayer.xml. + +.. _class_OpenXRCompositionLayer: + +OpenXRCompositionLayer +====================== + +**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`OpenXRCompositionLayerCylinder`, :ref:`OpenXRCompositionLayerEquirect`, :ref:`OpenXRCompositionLayerQuad` + +The parent class of all OpenXR composition layer nodes. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Composition layers allow 2D viewports to be displayed inside of the headset by the XR compositor through special projections that retain their quality. This allows for rendering clear text while keeping the layer at a native resolution. + +\ **Note:** If the OpenXR runtime doesn't support the given composition layer type, a fallback mesh can be generated with a :ref:`ViewportTexture`, in order to emulate the composition layer. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------+-----------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`alpha_blend` | ``false`` | + +---------------------------------------+-----------------------------------------------------------------------------+-----------+ + | :ref:`SubViewport` | :ref:`layer_viewport` | | + +---------------------------------------+-----------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`sort_order` | ``1`` | + +---------------------------------------+-----------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_natively_supported`\ (\ ) |const| | + +-------------------------+-------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_OpenXRCompositionLayer_property_alpha_blend: + +.. rst-class:: classref-property + +:ref:`bool` **alpha_blend** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_alpha_blend**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_alpha_blend**\ (\ ) + +Enables the blending the layer using its alpha channel. + +Can be combined with :ref:`Viewport.transparent_bg` to give the layer a transparent background. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_layer_viewport: + +.. rst-class:: classref-property + +:ref:`SubViewport` **layer_viewport** + +.. rst-class:: classref-property-setget + +- |void| **set_layer_viewport**\ (\ value\: :ref:`SubViewport`\ ) +- :ref:`SubViewport` **get_layer_viewport**\ (\ ) + +The :ref:`SubViewport` to render on the composition layer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_sort_order: + +.. rst-class:: classref-property + +:ref:`int` **sort_order** = ``1`` + +.. rst-class:: classref-property-setget + +- |void| **set_sort_order**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sort_order**\ (\ ) + +The sort order for this composition layer. Higher numbers will be shown in front of lower numbers. + +\ **Note:** This will have no effect if a fallback mesh is being used. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_OpenXRCompositionLayer_method_is_natively_supported: + +.. rst-class:: classref-method + +:ref:`bool` **is_natively_supported**\ (\ ) |const| + +Returns true if the OpenXR runtime natively supports this composition layer type. + +\ **Note:** This will only return an accurate result after the OpenXR session has started. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_openxrcompositionlayercylinder.rst b/classes/class_openxrcompositionlayercylinder.rst new file mode 100644 index 000000000..10400d195 --- /dev/null +++ b/classes/class_openxrcompositionlayercylinder.rst @@ -0,0 +1,122 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerCylinder.xml. + +.. _class_OpenXRCompositionLayerCylinder: + +OpenXRCompositionLayerCylinder +============================== + +**Inherits:** :ref:`OpenXRCompositionLayer` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +An OpenXR composition layer that is rendered as an internal slice of a cylinder. + +.. rst-class:: classref-introduction-group + +Description +----------- + +An OpenXR composition layer that allows rendering a :ref:`SubViewport` on an internal slice of a cylinder. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+-------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`aspect_ratio` | ``1.0`` | + +---------------------------+-------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`central_angle` | ``1.5708`` | + +---------------------------+-------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`fallback_segments` | ``10`` | + +---------------------------+-------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`radius` | ``1.0`` | + +---------------------------+-------------------------------------------------------------------------------------------+------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_OpenXRCompositionLayerCylinder_property_aspect_ratio: + +.. rst-class:: classref-property + +:ref:`float` **aspect_ratio** = ``1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_aspect_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_aspect_ratio**\ (\ ) + +The aspect ratio of the slice. Used to set the height relative to the width. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerCylinder_property_central_angle: + +.. rst-class:: classref-property + +:ref:`float` **central_angle** = ``1.5708`` + +.. rst-class:: classref-property-setget + +- |void| **set_central_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_central_angle**\ (\ ) + +The central angle of the cylinder. Used to set the width. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerCylinder_property_fallback_segments: + +.. rst-class:: classref-property + +:ref:`int` **fallback_segments** = ``10`` + +.. rst-class:: classref-property-setget + +- |void| **set_fallback_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fallback_segments**\ (\ ) + +The number of segments to use in the fallback mesh. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerCylinder_property_radius: + +.. rst-class:: classref-property + +:ref:`float` **radius** = ``1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) + +The radius of the cylinder. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_openxrcompositionlayerequirect.rst b/classes/class_openxrcompositionlayerequirect.rst new file mode 100644 index 000000000..a6dcd5442 --- /dev/null +++ b/classes/class_openxrcompositionlayerequirect.rst @@ -0,0 +1,141 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerEquirect.xml. + +.. _class_OpenXRCompositionLayerEquirect: + +OpenXRCompositionLayerEquirect +============================== + +**Inherits:** :ref:`OpenXRCompositionLayer` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +An OpenXR composition layer that is rendered as an internal slice of a sphere. + +.. rst-class:: classref-introduction-group + +Description +----------- + +An OpenXR composition layer that allows rendering a :ref:`SubViewport` on an internal slice of a sphere. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + | :ref:`float` | :ref:`central_horizontal_angle` | ``1.5708`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + | :ref:`int` | :ref:`fallback_segments` | ``10`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + | :ref:`float` | :ref:`lower_vertical_angle` | ``0.785398`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + | :ref:`float` | :ref:`radius` | ``1.0`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + | :ref:`float` | :ref:`upper_vertical_angle` | ``0.785398`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle: + +.. rst-class:: classref-property + +:ref:`float` **central_horizontal_angle** = ``1.5708`` + +.. rst-class:: classref-property-setget + +- |void| **set_central_horizontal_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_central_horizontal_angle**\ (\ ) + +The central horizontal angle of the sphere. Used to set the width. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerEquirect_property_fallback_segments: + +.. rst-class:: classref-property + +:ref:`int` **fallback_segments** = ``10`` + +.. rst-class:: classref-property-setget + +- |void| **set_fallback_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fallback_segments**\ (\ ) + +The number of segments to use in the fallback mesh. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle: + +.. rst-class:: classref-property + +:ref:`float` **lower_vertical_angle** = ``0.785398`` + +.. rst-class:: classref-property-setget + +- |void| **set_lower_vertical_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lower_vertical_angle**\ (\ ) + +The lower vertical angle of the sphere. Used (together with :ref:`upper_vertical_angle`) to set the height. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerEquirect_property_radius: + +.. rst-class:: classref-property + +:ref:`float` **radius** = ``1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) + +The radius of the sphere. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle: + +.. rst-class:: classref-property + +:ref:`float` **upper_vertical_angle** = ``0.785398`` + +.. rst-class:: classref-property-setget + +- |void| **set_upper_vertical_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_upper_vertical_angle**\ (\ ) + +The upper vertical angle of the sphere. Used (together with :ref:`lower_vertical_angle`) to set the height. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_tilemaplayergroup.rst b/classes/class_openxrcompositionlayerquad.rst similarity index 57% rename from classes/class_tilemaplayergroup.rst rename to classes/class_openxrcompositionlayerquad.rst index e02ad3a89..a2065fd58 100644 --- a/classes/class_tilemaplayergroup.rst +++ b/classes/class_openxrcompositionlayerquad.rst @@ -3,27 +3,23 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapLayerGroup.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRCompositionLayerQuad.xml. -.. _class_TileMapLayerGroup: +.. _class_OpenXRCompositionLayerQuad: -TileMapLayerGroup -================= +OpenXRCompositionLayerQuad +========================== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`OpenXRCompositionLayer` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TileMap` - -Groups a set of tile map layers together, allowing them to share a provided :ref:`TileSet`. +An OpenXR composition layer that is rendered as a quad. .. rst-class:: classref-introduction-group Description ----------- -Groups together tile map layers as part or the same map, replacing the :ref:`TileMap` node. Child layers will use this node's :ref:`tile_set`. - -The editor also uses **TileMapLayerGroup** as a way to store which layers are selected in a given group. This allows highlighting the currently selected layers. +An OpenXR composition layer that allows rendering a :ref:`SubViewport` on a quad. .. rst-class:: classref-reftable-group @@ -33,9 +29,9 @@ Properties .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------+ - | :ref:`TileSet` | :ref:`tile_set` | - +-------------------------------+------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`quad_size` | ``Vector2(1, 1)`` | + +-------------------------------+-----------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator @@ -46,18 +42,18 @@ Properties Property Descriptions --------------------- -.. _class_TileMapLayerGroup_property_tile_set: +.. _class_OpenXRCompositionLayerQuad_property_quad_size: .. rst-class:: classref-property -:ref:`TileSet` **tile_set** +:ref:`Vector2` **quad_size** = ``Vector2(1, 1)`` .. rst-class:: classref-property-setget -- |void| **set_tileset**\ (\ value\: :ref:`TileSet`\ ) -- :ref:`TileSet` **get_tileset**\ (\ ) +- |void| **set_quad_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_quad_size**\ (\ ) -The assigned :ref:`TileSet`. This TileSet will be applied to all child layers. +The dimensions of the quad. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_openxrhand.rst b/classes/class_openxrhand.rst index af4ef5e29..9e7efb593 100644 --- a/classes/class_openxrhand.rst +++ b/classes/class_openxrhand.rst @@ -12,7 +12,7 @@ OpenXRHand **Deprecated:** Use :ref:`XRHandModifier3D` instead. -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` Node supporting hand and finger tracking in OpenXR. @@ -37,17 +37,15 @@ Properties .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------------------+------------------+ - | :ref:`BoneUpdate` | :ref:`bone_update` | ``0`` | - +-------------------------------------------------+---------------------------------------------------------------+------------------+ - | :ref:`Hands` | :ref:`hand` | ``0`` | - +-------------------------------------------------+---------------------------------------------------------------+------------------+ - | :ref:`NodePath` | :ref:`hand_skeleton` | ``NodePath("")`` | - +-------------------------------------------------+---------------------------------------------------------------+------------------+ - | :ref:`MotionRange` | :ref:`motion_range` | ``0`` | - +-------------------------------------------------+---------------------------------------------------------------+------------------+ - | :ref:`SkeletonRig` | :ref:`skeleton_rig` | ``0`` | - +-------------------------------------------------+---------------------------------------------------------------+------------------+ + +-------------------------------------------------+-------------------------------------------------------------+-------+ + | :ref:`BoneUpdate` | :ref:`bone_update` | ``0`` | + +-------------------------------------------------+-------------------------------------------------------------+-------+ + | :ref:`Hands` | :ref:`hand` | ``0`` | + +-------------------------------------------------+-------------------------------------------------------------+-------+ + | :ref:`MotionRange` | :ref:`motion_range` | ``0`` | + +-------------------------------------------------+-------------------------------------------------------------+-------+ + | :ref:`SkeletonRig` | :ref:`skeleton_rig` | ``0`` | + +-------------------------------------------------+-------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator @@ -233,23 +231,6 @@ Specifies whether this node tracks the left or right hand of the player. ---- -.. _class_OpenXRHand_property_hand_skeleton: - -.. rst-class:: classref-property - -:ref:`NodePath` **hand_skeleton** = ``NodePath("")`` - -.. rst-class:: classref-property-setget - -- |void| **set_hand_skeleton**\ (\ value\: :ref:`NodePath`\ ) -- :ref:`NodePath` **get_hand_skeleton**\ (\ ) - -Set a :ref:`Skeleton3D` node for which the pose positions will be updated. - -.. rst-class:: classref-item-separator - ----- - .. _class_OpenXRHand_property_motion_range: .. rst-class:: classref-property @@ -278,7 +259,7 @@ Set the motion range (if supported) limiting the hand motion. - |void| **set_skeleton_rig**\ (\ value\: :ref:`SkeletonRig`\ ) - :ref:`SkeletonRig` **get_skeleton_rig**\ (\ ) -Set the type of skeleton rig the :ref:`hand_skeleton` is compliant with. +Set the type of skeleton rig the parent :ref:`Skeleton3D` is compliant with. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_physicalbonesimulator3d.rst b/classes/class_physicalbonesimulator3d.rst new file mode 100644 index 000000000..b23f74b6c --- /dev/null +++ b/classes/class_physicalbonesimulator3d.rst @@ -0,0 +1,122 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBoneSimulator3D.xml. + +.. _class_PhysicalBoneSimulator3D: + +PhysicalBoneSimulator3D +======================= + +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Node that can be the parent of :ref:`PhysicalBone3D` and can apply the simulation results to :ref:`Skeleton3D`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Node that can be the parent of :ref:`PhysicalBone3D` and can apply the simulation results to :ref:`Skeleton3D`. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_simulating_physics`\ (\ ) |const| | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_add_collision_exception`\ (\ exception\: :ref:`RID`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_remove_collision_exception`\ (\ exception\: :ref:`RID`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_start_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_stop_simulation`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_PhysicalBoneSimulator3D_method_is_simulating_physics: + +.. rst-class:: classref-method + +:ref:`bool` **is_simulating_physics**\ (\ ) |const| + +Returns a boolean that indicates whether the **PhysicalBoneSimulator3D** is running and simulating. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicalBoneSimulator3D_method_physical_bones_add_collision_exception: + +.. rst-class:: classref-method + +|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) + +Adds a collision exception to the physical bone. + +Works just like the :ref:`RigidBody3D` node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicalBoneSimulator3D_method_physical_bones_remove_collision_exception: + +.. rst-class:: classref-method + +|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) + +Removes a collision exception to the physical bone. + +Works just like the :ref:`RigidBody3D` node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicalBoneSimulator3D_method_physical_bones_start_simulation: + +.. rst-class:: classref-method + +|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) + +Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to start simulating and reacting to the physics world. + +Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PhysicalBoneSimulator3D_method_physical_bones_stop_simulation: + +.. rst-class:: classref-method + +|void| **physical_bones_stop_simulation**\ (\ ) + +Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to stop simulating. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 6707616fc..ae1701466 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1455,6 +1455,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/occlusion_culling/bvh_build_quality` | ``2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/occlusion_culling/jitter_projection` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/occlusion_culling/occlusion_rays_per_thread` | ``512`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/occlusion_culling/use_occlusion_culling` | ``false`` | @@ -10728,6 +10730,18 @@ The `Bounding Volume Hierarchy ` **rendering/occlusion_culling/jitter_projection** = ``true`` + +If ``true``, the projection used for rendering the occlusion buffer will be jittered. This can help prevent objects being incorrectly culled when visible through small gaps. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/occlusion_culling/occlusion_rays_per_thread: .. rst-class:: classref-property diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 54556ea9c..0bbf8350e 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -921,6 +921,8 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_get_texture`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ViewportUpdateMode` | :ref:`viewport_get_update_mode`\ (\ viewport\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_remove_canvas`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_active`\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) | @@ -11272,6 +11274,20 @@ Returns the viewport's last rendered frame. ---- +.. _class_RenderingServer_method_viewport_get_update_mode: + +.. rst-class:: classref-method + +:ref:`ViewportUpdateMode` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID`\ ) |const| + +Returns the viewport's update mode. See :ref:`ViewportUpdateMode` constants for options. + +\ **Warning:** Calling this from any thread other than the rendering thread will be detrimental to performance. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_viewport_remove_canvas: .. rst-class:: classref-method diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 4bbe478b6..4a1bd4659 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -42,13 +42,13 @@ Properties .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`animate_physical_bones` | ``true`` | - +---------------------------+---------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`motion_scale` | ``1.0`` | - +---------------------------+---------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`show_rest_only` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------+-----------+ + +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ + | :ref:`ModifierCallbackModeProcess` | :ref:`modifier_callback_mode_process` | ``1`` | + +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`motion_scale` | ``1.0`` | + +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`show_rest_only` | ``false`` | + +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -73,6 +73,8 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_update_bone_child_transform`\ (\ bone_idx\: :ref:`int`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_animate_physical_bones`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_bone_children`\ (\ bone_idx\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count`\ (\ ) |const| | @@ -121,14 +123,20 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reset_bone_poses`\ (\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_animate_physical_bones`\ (\ enabled\: :ref:`bool`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_enabled`\ (\ bone_idx\: :ref:`int`, enabled\: :ref:`bool` = true\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_global_pose`\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_global_pose_override`\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_name`\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_parent`\ (\ bone_idx\: :ref:`int`, parent_idx\: :ref:`int`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_pose`\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_pose_position`\ (\ bone_idx\: :ref:`int`, position\: :ref:`Vector3`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_pose_rotation`\ (\ bone_idx\: :ref:`int`, rotation\: :ref:`Quaternion`\ ) | @@ -161,6 +169,20 @@ Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled`! + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_signal_bone_pose_changed: .. rst-class:: classref-signal @@ -199,6 +221,37 @@ Emitted when the value of :ref:`show_rest_only` **MODIFIER_CALLBACK_MODE_PROCESS_PHYSICS** = ``0`` + +Set a flag to process modification during physics frames (see :ref:`Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS`). + +.. _class_Skeleton3D_constant_MODIFIER_CALLBACK_MODE_PROCESS_IDLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ModifierCallbackModeProcess` **MODIFIER_CALLBACK_MODE_PROCESS_IDLE** = ``1`` + +Set a flag to process modification during process frames (see :ref:`Node.NOTIFICATION_INTERNAL_PROCESS`). + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Constants --------- @@ -221,20 +274,18 @@ This notification is received *before* the related :ref:`pose_updated` **animate_physical_bones** = ``true`` +:ref:`ModifierCallbackModeProcess` **modifier_callback_mode_process** = ``1`` .. rst-class:: classref-property-setget -- |void| **set_animate_physical_bones**\ (\ value\: :ref:`bool`\ ) -- :ref:`bool` **get_animate_physical_bones**\ (\ ) +- |void| **set_modifier_callback_mode_process**\ (\ value\: :ref:`ModifierCallbackModeProcess`\ ) +- :ref:`ModifierCallbackModeProcess` **get_modifier_callback_mode_process**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Sets the processing timing for the Modifier. .. rst-class:: classref-item-separator @@ -313,6 +364,8 @@ Clear all the bones in this skeleton. |void| **clear_bones_global_pose_override**\ (\ ) +**Deprecated:** This method may be changed or removed in future versions. + Removes the global pose override on all bones in the skeleton. .. rst-class:: classref-item-separator @@ -371,6 +424,18 @@ Force updates the bone transform for the bone at ``bone_idx`` and all of its chi ---- +.. _class_Skeleton3D_method_get_animate_physical_bones: + +.. rst-class:: classref-method + +:ref:`bool` **get_animate_physical_bones**\ (\ ) |const| + +**Deprecated:** This method may be changed or removed in future versions. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_get_bone_children: .. rst-class:: classref-method @@ -403,6 +468,8 @@ Returns the number of bones in the skeleton. Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. +\ **Note:** This is the global pose you set to the skeleton in the process, the final global pose can get overridden by modifiers in the deferred process, if you want to access the final global pose, use :ref:`SkeletonModifier3D.modification_processed`. + .. rst-class:: classref-item-separator ---- @@ -413,6 +480,8 @@ Returns the overall transform of the specified bone, with respect to the skeleto :ref:`Transform3D` **get_bone_global_pose_no_override**\ (\ bone_idx\: :ref:`int`\ ) |const| +**Deprecated:** This method may be changed or removed in future versions. + Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. .. rst-class:: classref-item-separator @@ -425,6 +494,8 @@ Returns the overall transform of the specified bone, with respect to the skeleto :ref:`Transform3D` **get_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`\ ) |const| +**Deprecated:** This method may be changed or removed in future versions. + Returns the global pose override transform for ``bone_idx``. .. rst-class:: classref-item-separator @@ -477,6 +548,8 @@ Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, t Returns the pose transform of the specified bone. +\ **Note:** This is the pose you set to the skeleton in the process, the final pose can get overridden by modifiers in the deferred process, if you want to access the final pose, use :ref:`SkeletonModifier3D.modification_processed`. + .. rst-class:: classref-item-separator ---- @@ -587,6 +660,8 @@ Returns all bones in the skeleton to their rest poses. |void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) +**Deprecated:** This method may be changed or removed in future versions. + Adds a collision exception to the physical bone. Works just like the :ref:`RigidBody3D` node. @@ -601,6 +676,8 @@ Works just like the :ref:`RigidBody3D` node. |void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) +**Deprecated:** This method may be changed or removed in future versions. + Removes a collision exception to the physical bone. Works just like the :ref:`RigidBody3D` node. @@ -615,6 +692,8 @@ Works just like the :ref:`RigidBody3D` node. |void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) +**Deprecated:** This method may be changed or removed in future versions. + Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to start simulating and reacting to the physics world. Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated. @@ -629,6 +708,8 @@ Optionally, a list of bone names can be passed-in, allowing only the passed-in b |void| **physical_bones_stop_simulation**\ (\ ) +**Deprecated:** This method may be changed or removed in future versions. + Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to stop simulating. .. rst-class:: classref-item-separator @@ -671,6 +752,18 @@ Sets all bone poses to rests. ---- +.. _class_Skeleton3D_method_set_animate_physical_bones: + +.. rst-class:: classref-method + +|void| **set_animate_physical_bones**\ (\ enabled\: :ref:`bool`\ ) + +**Deprecated:** This method may be changed or removed in future versions. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_set_bone_enabled: .. rst-class:: classref-method @@ -683,12 +776,28 @@ Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone po ---- +.. _class_Skeleton3D_method_set_bone_global_pose: + +.. rst-class:: classref-method + +|void| **set_bone_global_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) + +Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. + +\ **Note:** If other bone poses have been changed, this method executes an update process and will cause performance to deteriorate. If you know that multiple global poses will be applied, consider using :ref:`set_bone_pose` with precalculation. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_set_bone_global_pose_override: .. rst-class:: classref-method |void| **set_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) +**Deprecated:** This method may be changed or removed in future versions. + Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. \ ``amount`` is the interpolation strength that will be used when applying the pose, and ``persistent`` determines if the applied pose will remain. @@ -705,9 +814,7 @@ Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. |void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the bone name, ``name``, for the bone at ``bone_idx``. .. rst-class:: classref-item-separator @@ -727,6 +834,18 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If ---- +.. _class_Skeleton3D_method_set_bone_pose: + +.. rst-class:: classref-method + +|void| **set_bone_pose**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`\ ) + +Sets the pose transform, ``pose``, for the bone at ``bone_idx``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_set_bone_pose_position: .. rst-class:: classref-method diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index e110695ac..602dcb24f 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -12,7 +12,7 @@ SkeletonIK3D **Deprecated:** This class may be changed or removed in future versions. -**Inherits:** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A node used to rotate all bones of a :ref:`Skeleton3D` bone chain a way that places the end bone at a desired 3D position. @@ -21,7 +21,7 @@ A node used to rotate all bones of a :ref:`Skeleton3D` bone ch Description ----------- -SkeletonIK3D is used to rotate all bones of a :ref:`Skeleton3D` bone chain a way that places the end bone at a desired 3D position. A typical scenario for IK in games is to place a character's feet on the ground or a character's hands on a currently held object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the :ref:`Skeleton3D` ``bones_global_pose_override`` property for all affected bones in the chain. If fully applied, this overwrites any bone transform from :ref:`Animation`\ s or bone custom poses set by users. The applied amount can be controlled with the :ref:`interpolation` property. +SkeletonIK3D is used to rotate all bones of a :ref:`Skeleton3D` bone chain a way that places the end bone at a desired 3D position. A typical scenario for IK in games is to place a character's feet on the ground or a character's hands on a currently held object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the :ref:`Skeleton3D` ``bones_global_pose_override`` property for all affected bones in the chain. If fully applied, this overwrites any bone transform from :ref:`Animation`\ s or bone custom poses set by users. The applied amount can be controlled with the :ref:`SkeletonModifier3D.influence` property. :: @@ -35,13 +35,13 @@ SkeletonIK3D is used to rotate all bones of a :ref:`Skeleton3D skeleton_ik_node.stop() # Apply full IK effect - skeleton_ik_node.set_interpolation(1.0) + skeleton_ik_node.set_influence(1.0) # Apply half IK effect - skeleton_ik_node.set_interpolation(0.5) + skeleton_ik_node.set_influence(0.5) # Apply zero IK effect (a value at or below 0.01 also removes bones_global_pose_override on Skeleton) - skeleton_ik_node.set_interpolation(0.0) + skeleton_ik_node.set_influence(0.0) .. rst-class:: classref-introduction-group @@ -58,8 +58,6 @@ Properties .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`float` | :ref:`interpolation` | ``1.0`` | +---------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`magnet` | ``Vector3(0, 0, 0)`` | +---------------------------------------+---------------------------------------------------------------------------+-----------------------------------------------------+ @@ -107,23 +105,6 @@ Methods Property Descriptions --------------------- -.. _class_SkeletonIK3D_property_interpolation: - -.. rst-class:: classref-property - -:ref:`float` **interpolation** = ``1.0`` - -.. rst-class:: classref-property-setget - -- |void| **set_interpolation**\ (\ value\: :ref:`float`\ ) -- :ref:`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`. - -.. rst-class:: classref-item-separator - ----- - .. _class_SkeletonIK3D_property_magnet: .. rst-class:: classref-property diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst new file mode 100644 index 000000000..b36d4aa01 --- /dev/null +++ b/classes/class_skeletonmodifier3d.rst @@ -0,0 +1,109 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModifier3D.xml. + +.. _class_SkeletonModifier3D: + +SkeletonModifier3D +================== + +**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`OpenXRHand`, :ref:`PhysicalBoneSimulator3D`, :ref:`SkeletonIK3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` + +A Node that may modify Skeleton3D's bone. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**SkeletonModifier3D** retrieves a target :ref:`Skeleton3D` by having a :ref:`Skeleton3D` parent. + +If there is :ref:`AnimationMixer`, modification always performs after playback process of the :ref:`AnimationMixer`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+---------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`active` | ``true`` | + +---------------------------+---------------------------------------------------------------+----------+ + | :ref:`float` | :ref:`influence` | ``1.0`` | + +---------------------------+---------------------------------------------------------------+----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_SkeletonModifier3D_signal_modification_processed: + +.. rst-class:: classref-signal + +**modification_processed**\ (\ ) + +Notifies when the modification have been finished. + +\ **Note:** If you want to get the modified bone pose by the modifier, you must use :ref:`Skeleton3D.get_bone_pose` or :ref:`Skeleton3D.get_bone_global_pose` at the moment this signal is fired. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_SkeletonModifier3D_property_active: + +.. rst-class:: classref-property + +:ref:`bool` **active** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_active**\ (\ ) + +If ``true``, the **SkeletonModifier3D** will be processing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SkeletonModifier3D_property_influence: + +.. rst-class:: classref-property + +:ref:`float` **influence** = ``1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_influence**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_influence**\ (\ ) + +Sets the influence of the modification. + +\ **Note:** This value is used by :ref:`Skeleton3D` to blend, so the **SkeletonModifier3D** should always apply only 100% of the result without interpolation. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_skeletonprofile.rst b/classes/class_skeletonprofile.rst index a99979330..95864a8c0 100644 --- a/classes/class_skeletonprofile.rst +++ b/classes/class_skeletonprofile.rst @@ -79,6 +79,8 @@ Methods +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_texture`\ (\ group_idx\: :ref:`int`\ ) |const| | +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_required`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_name`\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`StringName`\ ) | +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_bone_parent`\ (\ bone_idx\: :ref:`int`, bone_parent\: :ref:`StringName`\ ) | @@ -93,6 +95,8 @@ Methods +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_pose`\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`Transform3D`\ ) | +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_required`\ (\ bone_idx\: :ref:`int`, required\: :ref:`bool`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_tail_direction`\ (\ bone_idx\: :ref:`int`, tail_direction\: :ref:`TailDirection`\ ) | +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_texture`\ (\ group_idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | @@ -366,6 +370,20 @@ Returns the texture of the group at ``group_idx`` that will be the drawing group ---- +.. _class_SkeletonProfile_method_is_required: + +.. rst-class:: classref-method + +:ref:`bool` **is_required**\ (\ bone_idx\: :ref:`int`\ ) |const| + +Returns whether the bone at ``bone_idx`` is required for retargeting. + +This value is used by the bone map editor. If this method returns ``true``, and no bone is assigned, the handle color will be red on the bone map editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_SkeletonProfile_method_set_bone_name: .. rst-class:: classref-method @@ -454,6 +472,18 @@ Sets the reference pose transform for bone ``bone_idx``. ---- +.. _class_SkeletonProfile_method_set_required: + +.. rst-class:: classref-method + +|void| **set_required**\ (\ bone_idx\: :ref:`int`, required\: :ref:`bool`\ ) + +Sets the required status for bone ``bone_idx`` to ``required``. + +.. rst-class:: classref-item-separator + +---- + .. _class_SkeletonProfile_method_set_tail_direction: .. rst-class:: classref-method diff --git a/classes/class_statusindicator.rst b/classes/class_statusindicator.rst index 44a13273b..7b39b585f 100644 --- a/classes/class_statusindicator.rst +++ b/classes/class_statusindicator.rst @@ -48,7 +48,7 @@ Signals .. rst-class:: classref-signal -**pressed**\ (\ mouse_button\: :ref:`int`, position\: :ref:`Vector2i`\ ) +**pressed**\ (\ mouse_button\: :ref:`int`, mouse_position\: :ref:`Vector2i`\ ) Emitted when the status indicator is pressed. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 00e2fb3a5..6bc4c5def 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -55,6 +55,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`CaretType` | :ref:`caret_type` | ``0`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`context_menu_enabled` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`deselect_on_focus_loss_enabled` | ``true`` | diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 9e01fdfd3..ae09bcf29 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -448,6 +448,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`strip_diacritics`\ (\ string\: :ref:`String`\ ) |const| | @@ -4154,6 +4156,22 @@ Returns the string converted to lowercase. ---- +.. _class_TextServer_method_string_to_title: + +.. rst-class:: classref-method + +:ref:`String` **string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| + +Returns the string converted to title case. + +\ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` feature (supported by :ref:`TextServerAdvanced`). + +\ **Note:** The result may be longer or shorter than the original. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_string_to_upper: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 8b90346d1..b3f9b1833 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -454,6 +454,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_title`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_strip_diacritics`\ (\ string\: :ref:`String`\ ) |virtual| |const| | @@ -3422,6 +3424,20 @@ Returns the string converted to lowercase. ---- +.. _class_TextServerExtension_private_method__string_to_title: + +.. rst-class:: classref-method + +:ref:`String` **_string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| + +**Optional.**\ + +Returns the string converted to title case. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__string_to_upper: .. rst-class:: classref-method diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index f417a78b3..4620d55e6 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -13,7 +13,9 @@ TileMap ======= -**Inherits:** :ref:`TileMapLayerGroup` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Deprecated:** Use multiple :ref:`TileMapLayer` nodes instead. + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Node for 2D tile-based maps. @@ -64,6 +66,8 @@ Properties +----------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`rendering_quadrant_size` | ``16`` | +----------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ + | :ref:`TileSet` | :ref:`tile_set` | | + +----------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -310,6 +314,23 @@ The quadrant size does not apply on Y-sorted layers, as tiles are be grouped by \ **Note:** As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the TileMap's local coordinate system. +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMap_property_tile_set: + +.. rst-class:: classref-property + +:ref:`TileSet` **tile_set** + +.. rst-class:: classref-property-setget + +- |void| **set_tileset**\ (\ value\: :ref:`TileSet`\ ) +- :ref:`TileSet` **get_tileset**\ (\ ) + +The :ref:`TileSet` used by this **TileMap**. The textures, collisions, and additional behavior of all available tiles are stored here. + .. rst-class:: classref-section-separator ---- @@ -437,7 +458,9 @@ Forces the TileMap and the layer ``layer`` to update. :ref:`int` **get_cell_alternative_tile**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| -Returns the tile alternative ID of the cell on layer ``layer`` at ``coords``. If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. +Returns the tile alternative ID of the cell on layer ``layer`` at ``coords``. + +If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. If ``layer`` is negative, the layers are accessed from the last one. @@ -453,7 +476,7 @@ If ``layer`` is negative, the layers are accessed from the last one. Returns the tile atlas coordinates ID of the cell on layer ``layer`` at coordinates ``coords``. Returns ``Vector2i(-1, -1)`` if the cell does not exist. -If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. +If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw atlas coordinate identifier. See :ref:`TileSet.map_tile_proxy`. If ``layer`` is negative, the layers are accessed from the last one. @@ -469,7 +492,7 @@ If ``layer`` is negative, the layers are accessed from the last one. Returns the tile source ID of the cell on layer ``layer`` at coordinates ``coords``. Returns ``-1`` if the cell does not exist. -If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. +If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw source identifier. See :ref:`TileSet.map_tile_proxy`. If ``layer`` is negative, the layers are accessed from the last one. @@ -487,8 +510,6 @@ Returns the :ref:`TileData` object associated with the given cel If ``layer`` is negative, the layers are accessed from the last one. -If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. - :: func get_clicked_tile_power(): @@ -499,6 +520,8 @@ If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s til else: return 0 +If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies. See :ref:`TileSet.map_tile_proxy`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst new file mode 100644 index 000000000..c9884e074 --- /dev/null +++ b/classes/class_tilemaplayer.rst @@ -0,0 +1,761 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapLayer.xml. + +.. _class_TileMapLayer: + +TileMapLayer +============ + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +Node for 2D tile-based maps. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Node for 2D tile-based maps. A **TileMapLayer** uses a :ref:`TileSet` which contain a list of tiles which are used to create grid-based maps. Unlike the :ref:`TileMap` node, which is deprecated, **TileMapLayer** has only one layer of tiles. You can use several **TileMapLayer** to achieve the same result as a :ref:`TileMap` node. + +For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a :ref:`TileSetScenesCollectionSource` may be initialized after their parent. This is only queued when inside the scene tree. + +To force an update earlier on, call :ref:`update_internals`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`bool` | :ref:`collision_enabled` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`DebugVisibilityMode` | :ref:`collision_visibility_mode` | ``0`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`bool` | :ref:`enabled` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`bool` | :ref:`navigation_enabled` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`DebugVisibilityMode` | :ref:`navigation_visibility_mode` | ``0`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`rendering_quadrant_size` | ``16`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`PackedByteArray` | :ref:`tile_map_data` | ``PackedByteArray(0, 0)`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`TileSet` | :ref:`tile_set` | | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`bool` | :ref:`use_kinematic_bodies` | ``false`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`y_sort_origin` | ``0`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tile_data_runtime_update`\ (\ coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_use_tile_data_runtime_update`\ (\ coords\: :ref:`Vector2i`\ ) |virtual| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_cell`\ (\ coords\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fix_invalid_tiles`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_alternative_tile`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_cell_atlas_coords`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_source_id`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileData` | :ref:`get_cell_tile_data`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_coords_for_body_rid`\ (\ body\: :ref:`RID`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_neighbor_cell`\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileMapPattern` | :ref:`get_pattern`\ (\ coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_surrounding_cells`\ (\ coords\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_used_cells`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_used_cells_by_id`\ (\ source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_used_rect`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_body_rid`\ (\ body\: :ref:`RID`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`local_to_map`\ (\ local_position\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`map_pattern`\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`map_to_local`\ (\ map_position\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_runtime_tile_data_update`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell`\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cells_terrain_connect`\ (\ cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cells_terrain_path`\ (\ path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ map\: :ref:`RID`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pattern`\ (\ position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_internals`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_TileMapLayer_signal_changed: + +.. rst-class:: classref-signal + +**changed**\ (\ ) + +Emitted when this **TileMapLayer**'s properties changes. This includes modified cells, properties, or changes made to its assigned :ref:`TileSet`. + +\ **Note:** This signal may be emitted very often when batch-modifying a **TileMapLayer**. Avoid executing complex processing in a connected function, and consider delaying it to the end of the frame instead (i.e. calling :ref:`Object.call_deferred`). + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_TileMapLayer_DebugVisibilityMode: + +.. rst-class:: classref-enumeration + +enum **DebugVisibilityMode**: + +.. _class_TileMapLayer_constant_DEBUG_VISIBILITY_MODE_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`DebugVisibilityMode` **DEBUG_VISIBILITY_MODE_DEFAULT** = ``0`` + +Hide the collisions or navigation debug shapes in the editor, and use the debug settings to determine their visibility in game (i.e. :ref:`SceneTree.debug_collisions_hint` or :ref:`SceneTree.debug_navigation_hint`). + +.. _class_TileMapLayer_constant_DEBUG_VISIBILITY_MODE_FORCE_HIDE: + +.. rst-class:: classref-enumeration-constant + +:ref:`DebugVisibilityMode` **DEBUG_VISIBILITY_MODE_FORCE_HIDE** = ``2`` + +Always hide the collisions or navigation debug shapes. + +.. _class_TileMapLayer_constant_DEBUG_VISIBILITY_MODE_FORCE_SHOW: + +.. rst-class:: classref-enumeration-constant + +:ref:`DebugVisibilityMode` **DEBUG_VISIBILITY_MODE_FORCE_SHOW** = ``1`` + +Always show the collisions or navigation debug shapes. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_TileMapLayer_property_collision_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **collision_enabled** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collision_enabled**\ (\ ) + +Enable or disable collisions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_collision_visibility_mode: + +.. rst-class:: classref-property + +:ref:`DebugVisibilityMode` **collision_visibility_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_collision_visibility_mode**\ (\ value\: :ref:`DebugVisibilityMode`\ ) +- :ref:`DebugVisibilityMode` **get_collision_visibility_mode**\ (\ ) + +Show or hide the **TileMapLayer**'s collision shapes. If set to :ref:`DEBUG_VISIBILITY_MODE_DEFAULT`, this depends on the show collision debug settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **enabled** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) + +If ``false``, disables this **TileMapLayer** completely (rendering, collision, navigation, scene tiles, etc.) + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_navigation_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **navigation_enabled** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_navigation_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_navigation_enabled**\ (\ ) + +If ``true``, navigation regions are enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_navigation_visibility_mode: + +.. rst-class:: classref-property + +:ref:`DebugVisibilityMode` **navigation_visibility_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_navigation_visibility_mode**\ (\ value\: :ref:`DebugVisibilityMode`\ ) +- :ref:`DebugVisibilityMode` **get_navigation_visibility_mode**\ (\ ) + +Show or hide the **TileMapLayer**'s navigation meshes. If set to :ref:`DEBUG_VISIBILITY_MODE_DEFAULT`, this depends on the show navigation debug settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_rendering_quadrant_size: + +.. rst-class:: classref-property + +:ref:`int` **rendering_quadrant_size** = ``16`` + +.. rst-class:: classref-property-setget + +- |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rendering_quadrant_size**\ (\ ) + +The **TileMapLayer**'s quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. :ref:`rendering_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quandrant size groups together ``16 * 16 = 256`` tiles. + +The quadrant size does not apply on a Y-sorted **TileMapLayer**, as tiles are be grouped by Y position instead in that case. + +\ **Note:** As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the **TileMapLayer**'s local coordinate system. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_tile_map_data: + +.. rst-class:: classref-property + +:ref:`PackedByteArray` **tile_map_data** = ``PackedByteArray(0, 0)`` + +.. rst-class:: classref-property-setget + +- |void| **set_tile_map_data_from_array**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_tile_map_data_as_array**\ (\ ) + +The raw tile map data as a byte array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_tile_set: + +.. rst-class:: classref-property + +:ref:`TileSet` **tile_set** + +.. rst-class:: classref-property-setget + +- |void| **set_tile_set**\ (\ value\: :ref:`TileSet`\ ) +- :ref:`TileSet` **get_tile_set**\ (\ ) + +The :ref:`TileSet` used by this layer. The textures, collisions, and additional behavior of all available tiles are stored here. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_use_kinematic_bodies: + +.. rst-class:: classref-property + +:ref:`bool` **use_kinematic_bodies** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_use_kinematic_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_kinematic_bodies**\ (\ ) + +If ``true``, this **TileMapLayer** collision shapes will be instantiated as kinematic bodies. This can be needed for moving **TileMapLayer** nodes (i.e. moving platforms). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_property_y_sort_origin: + +.. rst-class:: classref-property + +:ref:`int` **y_sort_origin** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_y_sort_origin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_y_sort_origin**\ (\ ) + +This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level. This can be useful for top-down view games. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_TileMapLayer_private_method__tile_data_runtime_update: + +.. rst-class:: classref-method + +|void| **_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| + +Called with a :ref:`TileData` object about to be used internally by the **TileMapLayer**, allowing its modification at runtime. + +This method is only called if :ref:`_use_tile_data_runtime_update` is implemented and returns ``true`` for the given tile ``coords``. + +\ **Warning:** The ``tile_data`` object's sub-resources are the same as the one in the TileSet. Modifying them might impact the whole TileSet. Instead, make sure to duplicate those resources. + +\ **Note:** If the properties of ``tile_data`` object should change over time, use :ref:`notify_runtime_tile_data_update` to notify the **TileMapLayer** it needs an update. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_private_method__use_tile_data_runtime_update: + +.. rst-class:: classref-method + +:ref:`bool` **_use_tile_data_runtime_update**\ (\ coords\: :ref:`Vector2i`\ ) |virtual| + +Should return ``true`` if the tile at coordinates ``coords`` requires a runtime update. + +\ **Warning:** Make sure this function only returns ``true`` when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty. + +\ **Note:** If the result of this function should change, use :ref:`notify_runtime_tile_data_update` to notify the **TileMapLayer** it needs an update. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_clear: + +.. rst-class:: classref-method + +|void| **clear**\ (\ ) + +Clears all cells. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_erase_cell: + +.. rst-class:: classref-method + +|void| **erase_cell**\ (\ coords\: :ref:`Vector2i`\ ) + +Erases the cell at coordinates ``coords``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_fix_invalid_tiles: + +.. rst-class:: classref-method + +|void| **fix_invalid_tiles**\ (\ ) + +Clears cells containing tiles that do not exist in the :ref:`tile_set`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_cell_alternative_tile: + +.. rst-class:: classref-method + +:ref:`int` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| + +Returns the tile alternative ID of the cell at coordinates ``coords``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_cell_atlas_coords: + +.. rst-class:: classref-method + +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| + +Returns the tile atlas coordinates ID of the cell at coordinates ``coords``. Returns ``Vector2i(-1, -1)`` if the cell does not exist. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_cell_source_id: + +.. rst-class:: classref-method + +:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| + +Returns the tile source ID of the cell at coordinates ``coords``. Returns ``-1`` if the cell does not exist. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_cell_tile_data: + +.. rst-class:: classref-method + +:ref:`TileData` **get_cell_tile_data**\ (\ coords\: :ref:`Vector2i`\ ) |const| + +Returns the :ref:`TileData` object associated with the given cell, or ``null`` if the cell does not exist or is not a :ref:`TileSetAtlasSource`. + +:: + + func get_clicked_tile_power(): + var clicked_cell = tile_map_layer.local_to_map(tile_map_layer.get_local_mouse_position()) + var data = tile_map_layer.get_cell_tile_data(clicked_cell) + if data: + return data.get_custom_data("power") + else: + return 0 + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_coords_for_body_rid: + +.. rst-class:: classref-method + +:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) |const| + +Returns the coordinates of the tile for given physics body :ref:`RID`. Such an :ref:`RID` can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_navigation_map: + +.. rst-class:: classref-method + +:ref:`RID` **get_navigation_map**\ (\ ) |const| + +Returns the :ref:`RID` of the :ref:`NavigationServer2D` navigation used by this **TileMapLayer**. + +By default this returns the default :ref:`World2D` navigation map, unless a custom map was provided using :ref:`set_navigation_map`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_neighbor_cell: + +.. rst-class:: classref-method + +:ref:`Vector2i` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| + +Returns the neighboring cell to the one at coordinates ``coords``, identified by the ``neighbor`` direction. This method takes into account the different layouts a TileMap can take. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_pattern: + +.. rst-class:: classref-method + +:ref:`TileMapPattern` **get_pattern**\ (\ coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) + +Creates and returns a new :ref:`TileMapPattern` from the given array of cells. See also :ref:`set_pattern`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_surrounding_cells: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) + +Returns the list of all neighboring cells to the one at ``coords``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_used_cells: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| + +Returns a :ref:`Vector2i` array with the positions of all cells containing a tile. A cell is considered empty if its source identifier equals ``-1``, its atlas coordinate identifier is ``Vector2(-1, -1)`` and its alternative identifier is ``-1``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_used_cells_by_id: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| + +Returns a :ref:`Vector2i` array with the positions of all cells containing a tile. Tiles may be filtered according to their source (``source_id``), their atlas coordinates (``atlas_coords``), or alternative id (``alternative_tile``). + +If a parameter has its value set to the default one, this parameter is not used to filter a cell. Thus, if all parameters have their respective default values, this method returns the same result as :ref:`get_used_cells`. + +A cell is considered empty if its source identifier equals ``-1``, its atlas coordinate identifier is ``Vector2(-1, -1)`` and its alternative identifier is ``-1``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_get_used_rect: + +.. rst-class:: classref-method + +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| + +Returns a rectangle enclosing the used (non-empty) tiles of the map. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_has_body_rid: + +.. rst-class:: classref-method + +:ref:`bool` **has_body_rid**\ (\ body\: :ref:`RID`\ ) |const| + +Returns whether the provided ``body`` :ref:`RID` belongs to one of this **TileMapLayer**'s cells. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_local_to_map: + +.. rst-class:: classref-method + +:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| + +Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node2D.to_local` before passing it to this method. See also :ref:`map_to_local`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_map_pattern: + +.. rst-class:: classref-method + +:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) + +Returns for the given coordinates ``coords_in_pattern`` in a :ref:`TileMapPattern` the corresponding cell coordinates if the pattern was pasted at the ``position_in_tilemap`` coordinates (see :ref:`set_pattern`). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating ``position_in_tile_map + coords_in_pattern``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_map_to_local: + +.. rst-class:: classref-method + +:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| + +Returns the centered position of a cell in the **TileMapLayer**'s local coordinate space. To convert the returned value into global coordinates, use :ref:`Node2D.to_global`. See also :ref:`local_to_map`. + +\ **Note:** This may not correspond to the visual position of the tile, i.e. it ignores the :ref:`TileData.texture_origin` property of individual tiles. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_notify_runtime_tile_data_update: + +.. rst-class:: classref-method + +|void| **notify_runtime_tile_data_update**\ (\ ) + +Notifies the **TileMapLayer** node that calls to :ref:`_use_tile_data_runtime_update` or :ref:`_tile_data_runtime_update` will lead to different results. This will thus trigger a **TileMapLayer** update. + +\ **Warning:** Updating the **TileMapLayer** is computationally expensive and may impact performance. Try to limit the number of calls to this function to avoid unnecessary update. + +\ **Note:** This does not trigger a direct update of the **TileMapLayer**, the update will be done at the end of the frame as usual (unless you call :ref:`update_internals`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_set_cell: + +.. rst-class:: classref-method + +|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) + +Sets the tile identifiers for the cell at coordinates ``coords``. Each tile of the :ref:`TileSet` is identified using three parts: + +- The source identifier ``source_id`` identifies a :ref:`TileSetSource` identifier. See :ref:`TileSet.set_source_id`, + +- The atlas coordinate identifier ``atlas_coords`` identifies a tile coordinates in the atlas (if the source is a :ref:`TileSetAtlasSource`). For :ref:`TileSetScenesCollectionSource` it should always be ``Vector2i(0, 0)``, + +- The alternative tile identifier ``alternative_tile`` identifies a tile alternative in the atlas (if the source is a :ref:`TileSetAtlasSource`), and the scene for a :ref:`TileSetScenesCollectionSource`. + +If ``source_id`` is set to ``-1``, ``atlas_coords`` to ``Vector2i(-1, -1)``, or ``alternative_tile`` to ``-1``, the cell will be erased. An erased cell gets **all** its identifiers automatically set to their respective invalid values, namely ``-1``, ``Vector2i(-1, -1)`` and ``-1``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_set_cells_terrain_connect: + +.. rst-class:: classref-method + +|void| **set_cells_terrain_connect**\ (\ cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) + +Update all the cells in the ``cells`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. + +If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. + +\ **Note:** To work correctly, this method requires the **TileMapLayer**'s TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_set_cells_terrain_path: + +.. rst-class:: classref-method + +|void| **set_cells_terrain_path**\ (\ path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) + +Update all the cells in the ``path`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. + +If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. + +\ **Note:** To work correctly, this method requires the **TileMapLayer**'s TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_set_navigation_map: + +.. rst-class:: classref-method + +|void| **set_navigation_map**\ (\ map\: :ref:`RID`\ ) + +Sets a custom ``map`` as a :ref:`NavigationServer2D` navigation map. If not set, uses the default :ref:`World2D` navigation map instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_set_pattern: + +.. rst-class:: classref-method + +|void| **set_pattern**\ (\ position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) + +Pastes the :ref:`TileMapPattern` at the given ``position`` in the tile map. See also :ref:`get_pattern`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TileMapLayer_method_update_internals: + +.. rst-class:: classref-method + +|void| **update_internals**\ (\ ) + +Triggers a direct update of the **TileMapLayer**. Usually, calling this function is not needed, as **TileMapLayer** node updates automatically when one of its properties or cells is modified. + +However, for performance reasons, those updates are batched and delayed to the end of the frame. Calling this function will force the **TileMapLayer** to update right away instead. + +\ **Warning:** Updating the **TileMapLayer** is computationally expensive and may impact performance. Try to limit the number of updates and how many tiles they impact. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index f1356fb73..e156f6e53 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -399,7 +399,7 @@ Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM`, mouse_button_index\: :ref:`int`\ ) +**empty_clicked**\ (\ click_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Emitted when a mouse button is clicked in the empty space of the tree. @@ -459,7 +459,7 @@ Emitted when an item's icon is double-clicked. For a signal that emits when any .. rst-class:: classref-signal -**item_mouse_selected**\ (\ position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) +**item_mouse_selected**\ (\ mouse_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Emitted when an item is selected with a mouse button. diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 21ddd7b2b..94420d854 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -28,7 +28,7 @@ In computer programming, a Variant class is a class that is designed to store a foo = "Now foo is a string!" foo = RefCounted.new() # foo is an Object var bar: int = 2 # bar is a statically typed integer. - # bar = "Uh oh! I can't make static variables become a different type!" + # bar = "Uh oh! I can't make statically typed variables become a different type!" .. code-tab:: csharp @@ -62,7 +62,7 @@ The global :ref:`@GlobalScope.typeof` function match typeof(foo): TYPE_NIL: print("foo is null") - TYPE_INTEGER: + TYPE_INT: print("foo is an integer") TYPE_OBJECT: # Note that Objects are their own special category. diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index e8928d08e..8ea6a2a98 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -53,12 +53,16 @@ Methods +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_varying`\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`attach_node_to_frame`\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`connect_nodes_forced`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`detach_node_from_frame`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualShaderNode` | :ref:`get_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| | @@ -385,6 +389,18 @@ Adds a new varying value node to the shader. ---- +.. _class_VisualShader_method_attach_node_to_frame: + +.. rst-class:: classref-method + +|void| **attach_node_to_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) + +Attaches the given node to the given frame. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualShader_method_can_connect_nodes: .. rst-class:: classref-method @@ -421,6 +437,18 @@ Connects the specified nodes and ports, even if they can't be connected. Such co ---- +.. _class_VisualShader_method_detach_node_from_frame: + +.. rst-class:: classref-method + +|void| **detach_node_from_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) + +Detaches the given node from the frame it is attached to. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualShader_method_disconnect_nodes: .. rst-class:: classref-method diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index b134c13f7..d8126ad89 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -38,9 +38,11 @@ Properties .. table:: :widths: auto - +-----------------------+-----------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`output_port_for_preview` | ``-1`` | - +-----------------------+-----------------------------------------------------------------------------------------+--------+ + +-----------------------+---------------------------------------------------------------------------------------------+--------+ + | :ref:`int` | :ref:`linked_parent_graph_frame` | ``-1`` | + +-----------------------+---------------------------------------------------------------------------------------------+--------+ + | :ref:`int` | :ref:`output_port_for_preview` | ``-1`` | + +-----------------------+---------------------------------------------------------------------------------------------+--------+ .. rst-class:: classref-reftable-group @@ -170,6 +172,23 @@ Represents the size of the :ref:`PortType` enum. Property Descriptions --------------------- +.. _class_VisualShaderNode_property_linked_parent_graph_frame: + +.. rst-class:: classref-property + +:ref:`int` **linked_parent_graph_frame** = ``-1`` + +.. rst-class:: classref-property-setget + +- |void| **set_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frame**\ (\ ) + +Represents the index of the frame this node is linked to. If set to ``-1`` the node is not linked to any frame. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualShaderNode_property_output_port_for_preview: .. rst-class:: classref-property diff --git a/classes/class_visualshadernodecomment.rst b/classes/class_visualshadernodecomment.rst deleted file mode 100644 index 04d40fd55..000000000 --- a/classes/class_visualshadernodecomment.rst +++ /dev/null @@ -1,84 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeComment.xml. - -.. _class_VisualShaderNodeComment: - -VisualShaderNodeComment -======================= - -**Inherits:** :ref:`VisualShaderNodeResizableBase` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -A comment node to be placed on visual shader graph. - -.. rst-class:: classref-introduction-group - -Description ------------ - -A resizable rectangular area with changeable :ref:`title` and :ref:`description` used for better organizing of other visual shader nodes. - -.. rst-class:: classref-reftable-group - -Properties ----------- - -.. table:: - :widths: auto - - +-----------------------------+------------------------------------------------------------------------+---------------+ - | :ref:`String` | :ref:`description` | ``""`` | - +-----------------------------+------------------------------------------------------------------------+---------------+ - | :ref:`String` | :ref:`title` | ``"Comment"`` | - +-----------------------------+------------------------------------------------------------------------+---------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeComment_property_description: - -.. rst-class:: classref-property - -:ref:`String` **description** = ``""`` - -.. rst-class:: classref-property-setget - -- |void| **set_description**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_description**\ (\ ) - -An additional description which placed below the title. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VisualShaderNodeComment_property_title: - -.. rst-class:: classref-property - -:ref:`String` **title** = ``"Comment"`` - -.. rst-class:: classref-property-setget - -- |void| **set_title**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_title**\ (\ ) - -A title of the node. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |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.)` diff --git a/classes/class_visualshadernodeframe.rst b/classes/class_visualshadernodeframe.rst new file mode 100644 index 000000000..fd83aeccb --- /dev/null +++ b/classes/class_visualshadernodeframe.rst @@ -0,0 +1,188 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFrame.xml. + +.. _class_VisualShaderNodeFrame: + +VisualShaderNodeFrame +===================== + +**Inherits:** :ref:`VisualShaderNodeResizableBase` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +A frame other visual shader nodes can be attached to for better organization. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A rectangular frame that can be used to group visual shader nodes together to improve organization. + +Nodes attached to the frame will move with it when it is dragged and it can automatically resize to enclose all attached nodes. + +Its title, description and color can be customized. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`PackedInt32Array` | :ref:`attached_nodes` | ``PackedInt32Array()`` | + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`bool` | :ref:`autoshrink` | ``true`` | + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`tint_color` | ``Color(0.3, 0.3, 0.3, 0.75)`` | + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`bool` | :ref:`tint_color_enabled` | ``false`` | + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`String` | :ref:`title` | ``"Title"`` | + +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------+--------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_attached_node`\ (\ node\: :ref:`int`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_attached_node`\ (\ node\: :ref:`int`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeFrame_property_attached_nodes: + +.. rst-class:: classref-property + +:ref:`PackedInt32Array` **attached_nodes** = ``PackedInt32Array()`` + +.. rst-class:: classref-property-setget + +- |void| **set_attached_nodes**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_attached_nodes**\ (\ ) + +The list of nodes attached to the frame. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualShaderNodeFrame_property_autoshrink: + +.. rst-class:: classref-property + +:ref:`bool` **autoshrink** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_autoshrink_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_autoshrink_enabled**\ (\ ) + +If ``true``, the frame will automatically resize to enclose all attached nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualShaderNodeFrame_property_tint_color: + +.. rst-class:: classref-property + +:ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` + +.. rst-class:: classref-property-setget + +- |void| **set_tint_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_tint_color**\ (\ ) + +The color of the frame when :ref:`tint_color_enabled` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualShaderNodeFrame_property_tint_color_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **tint_color_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_tint_color_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_tint_color_enabled**\ (\ ) + +If ``true``, the frame will be tinted with the color specified in :ref:`tint_color`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualShaderNodeFrame_property_title: + +.. rst-class:: classref-property + +:ref:`String` **title** = ``"Title"`` + +.. rst-class:: classref-property-setget + +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) + +The title of the node. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_VisualShaderNodeFrame_method_add_attached_node: + +.. rst-class:: classref-method + +|void| **add_attached_node**\ (\ node\: :ref:`int`\ ) + +Adds a node to the list of nodes attached to the frame. Should not be called directly, use the :ref:`VisualShader.attach_node_to_frame` method instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualShaderNodeFrame_method_remove_attached_node: + +.. rst-class:: classref-method + +|void| **remove_attached_node**\ (\ node\: :ref:`int`\ ) + +Removes a node from the list of nodes attached to the frame. Should not be called directly, use the :ref:`VisualShader.detach_node_from_frame` method instead. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |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.)` diff --git a/classes/class_visualshadernoderesizablebase.rst b/classes/class_visualshadernoderesizablebase.rst index 79742d780..656712c60 100644 --- a/classes/class_visualshadernoderesizablebase.rst +++ b/classes/class_visualshadernoderesizablebase.rst @@ -12,7 +12,7 @@ VisualShaderNodeResizableBase **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeComment`, :ref:`VisualShaderNodeCurveTexture`, :ref:`VisualShaderNodeCurveXYZTexture`, :ref:`VisualShaderNodeGroupBase` +**Inherited By:** :ref:`VisualShaderNodeCurveTexture`, :ref:`VisualShaderNodeCurveXYZTexture`, :ref:`VisualShaderNodeFrame`, :ref:`VisualShaderNodeGroupBase` Base class for resizable nodes in a visual shader graph. diff --git a/classes/class_xrbodymodifier3d.rst b/classes/class_xrbodymodifier3d.rst index e9b890045..dfb34c61c 100644 --- a/classes/class_xrbodymodifier3d.rst +++ b/classes/class_xrbodymodifier3d.rst @@ -12,7 +12,7 @@ XRBodyModifier3D **Experimental:** This class may be changed or removed in future versions. -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A node for driving body meshes from :ref:`XRBodyTracker` data. @@ -51,8 +51,6 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`show_when_tracked` | ``true`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ - | :ref:`NodePath` | :ref:`target` | ``NodePath("")`` | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator @@ -200,23 +198,6 @@ Specifies the type of updates to perform on the bones. If true then the nodes visibility is determined by whether tracking data is available. -.. rst-class:: classref-item-separator - ----- - -.. _class_XRBodyModifier3D_property_target: - -.. rst-class:: classref-property - -:ref:`NodePath` **target** = ``NodePath("")`` - -.. rst-class:: classref-property-setget - -- |void| **set_target**\ (\ value\: :ref:`NodePath`\ ) -- :ref:`NodePath` **get_target**\ (\ ) - -A :ref:`NodePath` to a :ref:`Skeleton3D` to animate. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_xrhandmodifier3d.rst b/classes/class_xrhandmodifier3d.rst index 3db73adab..d5beb25f3 100644 --- a/classes/class_xrhandmodifier3d.rst +++ b/classes/class_xrhandmodifier3d.rst @@ -10,7 +10,7 @@ XRHandModifier3D ================ -**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A node for driving hand meshes from :ref:`XRHandTracker` data. @@ -45,8 +45,6 @@ Properties +-----------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`StringName` | :ref:`hand_tracker` | ``&"/user/left"`` | +-----------------------------------------------------+-------------------------------------------------------------------+-------------------+ - | :ref:`NodePath` | :ref:`target` | ``NodePath("")`` | - +-----------------------------------------------------+-------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator @@ -126,23 +124,6 @@ Specifies the type of updates to perform on the bones. The name of the :ref:`XRHandTracker` registered with :ref:`XRServer` to obtain the hand tracking data from. -.. rst-class:: classref-item-separator - ----- - -.. _class_XRHandModifier3D_property_target: - -.. rst-class:: classref-property - -:ref:`NodePath` **target** = ``NodePath("")`` - -.. rst-class:: classref-property-setget - -- |void| **set_target**\ (\ value\: :ref:`NodePath`\ ) -- :ref:`NodePath` **get_target**\ (\ ) - -A :ref:`NodePath` to a :ref:`Skeleton3D` to animate. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/index.rst b/classes/index.rst index 6bbbc55d4..06e0c5294 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -119,6 +119,7 @@ Nodes class_gpuparticlescollisionsphere3d class_graphedit class_graphelement + class_graphframe class_graphnode class_gridcontainer class_gridmap @@ -171,6 +172,10 @@ Nodes class_node3d class_occluderinstance3d class_omnilight3d + class_openxrcompositionlayer + class_openxrcompositionlayercylinder + class_openxrcompositionlayerequirect + class_openxrcompositionlayerquad class_openxrhand class_optionbutton class_panel @@ -184,6 +189,7 @@ Nodes class_pathfollow3d class_physicalbone2d class_physicalbone3d + class_physicalbonesimulator3d class_physicsbody2d class_physicsbody3d class_pinjoint2d @@ -218,6 +224,7 @@ Nodes class_skeleton2d class_skeleton3d class_skeletonik3d + class_skeletonmodifier3d class_slider class_sliderjoint3d class_softbody3d @@ -240,7 +247,7 @@ Nodes class_textureprogressbar class_texturerect class_tilemap - class_tilemaplayergroup + class_tilemaplayer class_timer class_touchscreenbutton class_tree @@ -571,7 +578,6 @@ Resources class_visualshadernodecolorfunc class_visualshadernodecolorop class_visualshadernodecolorparameter - class_visualshadernodecomment class_visualshadernodecompare class_visualshadernodeconstant class_visualshadernodecubemap @@ -589,6 +595,7 @@ Resources class_visualshadernodefloatfunc class_visualshadernodefloatop class_visualshadernodefloatparameter + class_visualshadernodeframe class_visualshadernodefresnel class_visualshadernodeglobalexpression class_visualshadernodegroupbase