diff --git a/classes/class_aimmodifier3d.rst b/classes/class_aimmodifier3d.rst index 07ca7f60284..ab47bc64d4a 100644 --- a/classes/class_aimmodifier3d.rst +++ b/classes/class_aimmodifier3d.rst @@ -48,6 +48,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Axis` | :ref:`get_primary_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_euler`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_secondary_rotation`\ (\ index\: :ref:`int`\ ) |const| | @@ -56,6 +58,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_primary_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_relative`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_use_euler`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_use_secondary_rotation`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | @@ -116,6 +120,18 @@ Returns the axis of the first rotation. It is enabled only if :ref:`is_using_eul ---- +.. _class_AimModifier3D_method_is_relative: + +.. rst-class:: classref-method + +:ref:`bool` **is_relative**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the relative option is enabled in the setting at ``index``. + +.. rst-class:: classref-item-separator + +---- + .. _class_AimModifier3D_method_is_using_euler: .. rst-class:: classref-method @@ -164,6 +180,22 @@ Sets the axis of the first rotation. It is enabled only if :ref:`is_using_euler( ---- +.. _class_AimModifier3D_method_set_relative: + +.. rst-class:: classref-method + +|void| **set_relative**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +Sets relative option in the setting at ``index`` to ``enabled``. + +If sets ``enabled`` to ``true``, the rotation is applied relative to the pose. + +If sets ``enabled`` to ``false``, the rotation is applied relative to the rest. It means to replace the current pose with the **AimModifier3D**'s result. + +.. rst-class:: classref-item-separator + +---- + .. _class_AimModifier3D_method_set_use_euler: .. rst-class:: classref-method diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 9dc025ebfd0..accdffe2c7e 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -118,6 +118,8 @@ The margin around the :ref:`region`. Useful The region used to draw the :ref:`atlas`. If either dimension of the region's size is ``0``, the value from :ref:`atlas` size will be used for that axis instead. +\ **Note:** The image size is always an integer, so the actual region size is rounded down. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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_canvasgroup.rst b/classes/class_canvasgroup.rst index 950c94569f4..58757349f43 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -19,9 +19,9 @@ Merges several 2D nodes into a single draw operation. Description ----------- -Child :ref:`CanvasItem` nodes of a **CanvasGroup** are drawn as a single object. It allows to e.g. draw overlapping translucent 2D nodes without blending (set :ref:`CanvasItem.self_modulate` property of **CanvasGroup** to achieve this effect). +Child :ref:`CanvasItem` nodes of a **CanvasGroup** are drawn as a single object. It allows to e.g. draw overlapping translucent 2D nodes without causing the overlapping sections to be more opaque than intended (set the :ref:`CanvasItem.self_modulate` property on the **CanvasGroup** to achieve this effect). -\ **Note:** The **CanvasGroup** uses a custom shader to read from the backbuffer to draw its children. Assigning a :ref:`Material` to the **CanvasGroup** overrides the builtin shader. To duplicate the behavior of the builtin shader in a custom :ref:`Shader` use the following: +\ **Note:** The **CanvasGroup** uses a custom shader to read from the backbuffer to draw its children. Assigning a :ref:`Material` to the **CanvasGroup** overrides the built-in shader. To duplicate the behavior of the built-in shader in a custom :ref:`Shader`, use the following: :: diff --git a/classes/class_editordock.rst b/classes/class_editordock.rst index 06fb2e1b38a..020cbf6d9a6 100644 --- a/classes/class_editordock.rst +++ b/classes/class_editordock.rst @@ -67,7 +67,7 @@ Properties :widths: auto +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | |bitfield|\[:ref:`DockLayout`\] | :ref:`available_layouts` | ``1`` | + | |bitfield|\[:ref:`DockLayout`\] | :ref:`available_layouts` | ``5`` | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ @@ -77,12 +77,18 @@ Properties +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`Shortcut` | :ref:`dock_shortcut` | | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global` | ``true`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`icon_name` | ``&""`` | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`String` | :ref:`layout_key` | ``""`` | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`String` | :ref:`title` | ``""`` | +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`title_color` | ``Color(0, 0, 0, 0)`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`transient` | ``false`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -99,6 +105,10 @@ Methods +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_update_layout`\ (\ layout\: :ref:`int`\ ) |virtual| | +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`open`\ (\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -123,15 +133,29 @@ flags **DockLayout**: :ref:`🔗` Allows placing the dock in the vertical dock slots on either side of the editor. -\ **Note:** Currently this flag has no effect because the bottom panel is not a proper dock slot. This means that the dock can always be vertical. - .. _class_EditorDock_constant_DOCK_LAYOUT_HORIZONTAL: .. rst-class:: classref-enumeration-constant :ref:`DockLayout` **DOCK_LAYOUT_HORIZONTAL** = ``2`` -Allows placing the dock in the editor's bottom panel. Implement :ref:`_update_layout()` to handle changing layouts. +Allows placing the dock in the editor's bottom panel. + +.. _class_EditorDock_constant_DOCK_LAYOUT_FLOATING: + +.. rst-class:: classref-enumeration-constant + +:ref:`DockLayout` **DOCK_LAYOUT_FLOATING** = ``4`` + +Allows making the dock floating (opened as a separate window). + +.. _class_EditorDock_constant_DOCK_LAYOUT_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`DockLayout` **DOCK_LAYOUT_ALL** = ``7`` + +Allows placing the dock in all available slots. .. rst-class:: classref-section-separator @@ -146,16 +170,14 @@ Property Descriptions .. rst-class:: classref-property -|bitfield|\[:ref:`DockLayout`\] **available_layouts** = ``1`` :ref:`🔗` +|bitfield|\[:ref:`DockLayout`\] **available_layouts** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_available_layouts**\ (\ value\: |bitfield|\[:ref:`DockLayout`\]\ ) - |bitfield|\[:ref:`DockLayout`\] **get_available_layouts**\ (\ ) -The available layouts for this dock, as a bitmask. - -If you want to make all layouts available, use ``available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL``. +The available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts. .. rst-class:: classref-item-separator @@ -214,6 +236,23 @@ The shortcut used to open the dock. This property can only be set before this do ---- +.. _class_EditorDock_property_global: + +.. rst-class:: classref-property + +:ref:`bool` **global** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_global**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_global**\ (\ ) + +If ``true``, the dock appears in the **Editor > Editor Docks** menu and can be closed. Non-global docks can still be closed using :ref:`close()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDock_property_icon_name: .. rst-class:: classref-property @@ -261,6 +300,40 @@ The key representing this dock in the editor's layout file. If empty, the dock's The title of the dock's tab. If empty, the dock's :ref:`Node.name` will be used. If the name is auto-generated (contains ``@``), the first child's name will be used instead. +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDock_property_title_color: + +.. rst-class:: classref-property + +:ref:`Color` **title_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_title_color**\ (\ ) + +The color of the dock tab's title. If its alpha is ``0.0``, the default font color will be used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDock_property_transient: + +.. rst-class:: classref-property + +:ref:`bool` **transient** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_transient**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_transient**\ (\ ) + +If ``true``, the dock is not automatically opened or closed when loading an editor layout, only moved. It also can't be opened using a shortcut. This is meant for docks that are opened and closed in specific cases, such as when selecting a :ref:`TileMap` or :ref:`AnimationTree` node. + .. rst-class:: classref-section-separator ---- @@ -307,6 +380,30 @@ Implement this method to handle the layout switching for this dock. ``layout`` i _update_layout(layout): box_container.vertical = (layout == DOCK_LAYOUT_VERTICAL) +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDock_method_close: + +.. rst-class:: classref-method + +|void| **close**\ (\ ) :ref:`🔗` + +Closes the dock, making its tab hidden. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDock_method_open: + +.. rst-class:: classref-method + +|void| **open**\ (\ ) :ref:`🔗` + +Opens the dock. It will appear in the last used dock slot. If the dock has no default slot, it will be opened floating. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index e087460b257..da89b7cf1be 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -262,6 +262,8 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/manage_external_storage` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/manage_media` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/master_clear` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/media_content_control` | @@ -1868,6 +1870,18 @@ Allows an application a broad access to external storage in scoped storage. See ---- +.. _class_EditorExportPlatformAndroid_property_permissions/manage_media: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/manage_media** :ref:`🔗` + +Allows an application to modify and delete media files on this device or any connected storage device without user confirmation. Applications must already be granted the ``READ_EXTERNAL_STORAGE`` or ``MANAGE_EXTERNAL_STORAGE`` permissions for this permission to take effect. See `MANAGE_MEDIA `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_permissions/master_clear: .. rst-class:: classref-property diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index cc02be81bd4..f7f34ad5c51 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -456,13 +456,13 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/collected` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + | :ref:`int` | :ref:`privacy/collected_data/search_history/collection_purposes` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/linked_to_user` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/used_for_tracking` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -3098,11 +3098,11 @@ Indicates whether your app uses purchase history for tracking. ---- -.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collected: +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_history/collected: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/collected** :ref:`🔗` Indicates whether your app collects search history. @@ -3110,11 +3110,11 @@ Indicates whether your app collects search history. ---- -.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collection_purposes: +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_history/collection_purposes: .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` +:ref:`int` **privacy/collected_data/search_history/collection_purposes** :ref:`🔗` The reasons your app collects search history. See `Describing data use in privacy manifests `__. @@ -3122,11 +3122,11 @@ The reasons your app collects search history. See `Describing data use in privac ---- -.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/linked_to_user: +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_history/linked_to_user: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/linked_to_user** :ref:`🔗` Indicates whether your app links search history to the user's identity. @@ -3134,11 +3134,11 @@ Indicates whether your app links search history to the user's identity. ---- -.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/used_for_tracking: +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_history/used_for_tracking: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses search history for tracking. diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index a7996f85b34..66ea1178157 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -418,13 +418,13 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/collected` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + | :ref:`int` | :ref:`privacy/collected_data/search_history/collection_purposes` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/linked_to_user` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/used_for_tracking` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2874,11 +2874,11 @@ Indicates whether your app uses purchase history for tracking. ---- -.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_hhistory/collected: +.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_history/collected: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/collected** :ref:`🔗` Indicates whether your app collects search history. @@ -2886,11 +2886,11 @@ Indicates whether your app collects search history. ---- -.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_hhistory/collection_purposes: +.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_history/collection_purposes: .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` +:ref:`int` **privacy/collected_data/search_history/collection_purposes** :ref:`🔗` The reasons your app collects search history. See `Describing data use in privacy manifests `__. @@ -2898,11 +2898,11 @@ The reasons your app collects search history. See `Describing data use in privac ---- -.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_hhistory/linked_to_user: +.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_history/linked_to_user: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/linked_to_user** :ref:`🔗` Indicates whether your app links search history to the user's identity. @@ -2910,11 +2910,11 @@ Indicates whether your app links search history to the user's identity. ---- -.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_hhistory/used_for_tracking: +.. _class_EditorExportPlatformMacOS_property_privacy/collected_data/search_history/used_for_tracking: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses search history for tracking. diff --git a/classes/class_editorexportplatformvisionos.rst b/classes/class_editorexportplatformvisionos.rst index b6435efbc30..91c238ab7c4 100644 --- a/classes/class_editorexportplatformvisionos.rst +++ b/classes/class_editorexportplatformvisionos.rst @@ -358,13 +358,13 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/collected` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + | :ref:`int` | :ref:`privacy/collected_data/search_history/collection_purposes` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/linked_to_user` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + | :ref:`bool` | :ref:`privacy/collected_data/search_history/used_for_tracking` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2404,11 +2404,11 @@ Indicates whether your app uses purchase history for tracking. ---- -.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/collected: +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_history/collected: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/collected** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/collected** :ref:`🔗` Indicates whether your app collects search history. @@ -2416,11 +2416,11 @@ Indicates whether your app collects search history. ---- -.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/collection_purposes: +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_history/collection_purposes: .. rst-class:: classref-property -:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** :ref:`🔗` +:ref:`int` **privacy/collected_data/search_history/collection_purposes** :ref:`🔗` The reasons your app collects search history. See `Describing data use in privacy manifests `__. @@ -2428,11 +2428,11 @@ The reasons your app collects search history. See `Describing data use in privac ---- -.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/linked_to_user: +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_history/linked_to_user: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/linked_to_user** :ref:`🔗` Indicates whether your app links search history to the user's identity. @@ -2440,11 +2440,11 @@ Indicates whether your app links search history to the user's identity. ---- -.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_hhistory/used_for_tracking: +.. _class_EditorExportPlatformVisionOS_property_privacy/collected_data/search_history/used_for_tracking: .. rst-class:: classref-property -:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** :ref:`🔗` +:ref:`bool` **privacy/collected_data/search_history/used_for_tracking** :ref:`🔗` Indicates whether your app uses search history for tracking. diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index 9731f3a5891..b7df1d8be9a 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -129,7 +129,7 @@ Returns the absolute path to the user's data folder. This folder should be used :ref:`String` **get_project_settings_dir**\ (\ ) |const| :ref:`🔗` -Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved. +Returns the relative path to the editor settings for this project. This is usually ``"res://.godot/editor"``. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved. .. rst-class:: classref-item-separator diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 6b7a61c67e1..816e7b22d6d 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -466,11 +466,19 @@ Dock slot, right side, upper-right (empty in default layout). Dock slot, right side, bottom-right (empty in default layout). +.. _class_EditorPlugin_constant_DOCK_SLOT_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`DockSlot` **DOCK_SLOT_BOTTOM** = ``8`` + +Bottom panel. + .. _class_EditorPlugin_constant_DOCK_SLOT_MAX: .. rst-class:: classref-enumeration-constant -:ref:`DockSlot` **DOCK_SLOT_MAX** = ``8`` +:ref:`DockSlot` **DOCK_SLOT_MAX** = ``9`` Represents the size of the :ref:`DockSlot` enum. @@ -1145,6 +1153,8 @@ Adds a plugin to the context menu. ``slot`` is the context menu where the plugin :ref:`Button` **add_control_to_bottom_panel**\ (\ control\: :ref:`Control`, title\: :ref:`String`, shortcut\: :ref:`Shortcut` = null\ ) :ref:`🔗` +**Deprecated:** Use :ref:`add_dock()` instead, with :ref:`EditorDock.default_slot` set to :ref:`DOCK_SLOT_BOTTOM`. + Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to a button that is outside the scene tree. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel()` and free it with :ref:`Node.queue_free()`. Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use :kbd:`Alt` modifier. @@ -1549,6 +1559,8 @@ Removes the specified context menu plugin. |void| **remove_control_from_bottom_panel**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` +**Deprecated:** Use :ref:`remove_dock()` instead. + Removes the control from the bottom panel. You have to manually :ref:`Node.queue_free()` the control. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index c6584cde411..96b526c0400 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -427,6 +427,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/on_save/warn_on_saving_large_text_resources` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filesystem/quick_open_dialog/default_display_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/quick_open_dialog/enable_fuzzy_matching` | @@ -3362,6 +3364,20 @@ If ``true``, when saving a file, the editor will rename the old file to a differ ---- +.. _class_EditorSettings_property_filesystem/on_save/warn_on_saving_large_text_resources: + +.. rst-class:: classref-property + +:ref:`bool` **filesystem/on_save/warn_on_saving_large_text_resources** :ref:`🔗` + +If ``true``, displays a warning toast message when saving a text-based scene or resource that is larger than 500 KiB on disk. This is typically caused by binary subresources being embedded as text, which results in slow and inefficient conversion to text. This in turn impacts scene saving and loading times. + +This should usually be resolved by moving the embedded binary subresource to its own binary resource file (``.res`` extension instead of ``.tres``). This is the preferred approach. Alternatively, the entire scene can be saved with the binary ``.scn`` format as opposed to ``.tscn``, but this will make it less friendly to version control systems. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_filesystem/quick_open_dialog/default_display_mode: .. rst-class:: classref-property diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index 40640ac61e2..2b13ad9b8d6 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -12,14 +12,18 @@ HeightMapShape3D **Inherits:** :ref:`Shape3D` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A 3D height map shape used for physics collision. +A 3D heightmap shape used for physics collision. .. rst-class:: classref-introduction-group Description ----------- -A 3D heightmap shape, intended for use in physics. Usually used to provide a shape for a :ref:`CollisionShape3D`. This type is most commonly used for terrain with vertices placed in a fixed width grid. Due to the nature of the heightmap, it cannot be used to model overhangs or caves, which would require multiple vertices at the same vertical location. Holes can be punched through the collision by assigning :ref:`@GDScript.NAN` to the height of the desired vertices (this is supported in both GodotPhysics3D and Jolt Physics). You could then insert meshes with their own separate collision to provide overhangs, caves, and so on. +A 3D heightmap shape, intended for use in physics to provide a shape for a :ref:`CollisionShape3D`. This type is most commonly used for terrain with vertices placed in a fixed-width grid. + +The heightmap is represented as a 2D grid of height values, which represent the position of grid points on the Y axis. Grid points are spaced 1 unit apart on the X and Z axes, and the grid is centered on the origin of the :ref:`CollisionShape3D` node. Internally, each grid square is divided into two triangles. + +Due to the nature of the heightmap, it cannot be used to model overhangs or caves, which would require multiple vertices at the same vertical location. Holes can be punched through the collision by assigning :ref:`@GDScript.NAN` to the height of the desired vertices (this is supported in both GodotPhysics3D and Jolt Physics). You could then insert meshes with their own separate collision to provide overhangs, caves, and so on. \ **Performance:** **HeightMapShape3D** is faster to check collisions against than :ref:`ConcavePolygonShape3D`, but it is significantly slower than primitive shapes like :ref:`BoxShape3D`. @@ -41,6 +45,8 @@ A heightmap collision shape can also be built by using an :ref:`Image` of the shape. However, keep in mind that GodotPhysics3D does not support non-uniform scaling: you'll need to scale the Y axis by the same amount as the X and Z axes, which means the values in :ref:`map_data` will need to be pre-scaled by the inverse of that scale. Also note that GodotPhysics3D does not support scaling at all for dynamic bodies (that is, non-frozen :ref:`RigidBody3D` nodes); to use a scaled **HeightMapShape3D** with those, you will need to use Jolt Physics. + .. rst-class:: classref-reftable-group Properties @@ -93,7 +99,7 @@ Property Descriptions - |void| **set_map_data**\ (\ value\: :ref:`PackedFloat32Array`\ ) - :ref:`PackedFloat32Array` **get_map_data**\ (\ ) -Height map data. The array's size must be equal to :ref:`map_width` multiplied by :ref:`map_depth`. +Heightmap data. The array's size must be equal to :ref:`map_width` multiplied by :ref:`map_depth`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array` for more details. @@ -112,7 +118,7 @@ Height map data. The array's size must be equal to :ref:`map_width`\ ) - :ref:`int` **get_map_depth**\ (\ ) -Number of vertices in the depth of the height map. Changing this will resize the :ref:`map_data`. +Number of vertices in the depth of the heightmap. Changing this will resize the :ref:`map_data`. .. rst-class:: classref-item-separator @@ -129,7 +135,7 @@ Number of vertices in the depth of the height map. Changing this will resize the - |void| **set_map_width**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_map_width**\ (\ ) -Number of vertices in the width of the height map. Changing this will resize the :ref:`map_data`. +Number of vertices in the width of the heightmap. Changing this will resize the :ref:`map_data`. .. rst-class:: classref-section-separator diff --git a/classes/class_ikmodifier3d.rst b/classes/class_ikmodifier3d.rst index 224c7f4dd83..285c6f7124e 100644 --- a/classes/class_ikmodifier3d.rst +++ b/classes/class_ikmodifier3d.rst @@ -23,7 +23,17 @@ Description Base class of :ref:`SkeletonModifier3D`\ s that has some joint lists and applies inverse kinematics. This class has some structs, enums, and helper methods which are useful to solve inverse kinematics. -\ **Note:** The IK classes that extend this handle rotation only, with bone lengths cached. It means that a position movement between processed chains can cause unintended movement. +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+-------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------+-------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group @@ -49,6 +59,30 @@ Methods .. rst-class:: classref-descriptions-group +Property Descriptions +--------------------- + +.. _class_IKModifier3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this **IKModifier3D** are ignored. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Method Descriptions ------------------- diff --git a/classes/class_image.rst b/classes/class_image.rst index 2c3b6254318..7ad416d3e9f 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -147,6 +147,8 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_dds_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_exr_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_jpg_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | @@ -1542,6 +1544,18 @@ Loads an image from the binary contents of a DDS file. ---- +.. _class_Image_method_load_exr_from_buffer: + +.. rst-class:: classref-method + +:ref:`Error` **load_exr_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` + +Loads an image from the binary contents of an OpenEXR file. + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_load_from_file: .. rst-class:: classref-method @@ -1770,8 +1784,6 @@ Saves the image as a DDS (DirectDraw Surface) file to a byte array. DDS is a con Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. -\ **Note:** The TinyEXR module is disabled in non-editor builds, which means :ref:`save_exr()` will return :ref:`@GlobalScope.ERR_UNAVAILABLE` when it is called from an exported project. - .. rst-class:: classref-item-separator ---- @@ -1784,8 +1796,6 @@ Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. -\ **Note:** The TinyEXR module is disabled in non-editor builds, which means :ref:`save_exr_to_buffer()` will return an empty byte array when it is called from an exported project. - .. rst-class:: classref-item-separator ---- diff --git a/classes/class_iterateik3d.rst b/classes/class_iterateik3d.rst index 23551aa7190..32101d8f126 100644 --- a/classes/class_iterateik3d.rst +++ b/classes/class_iterateik3d.rst @@ -36,6 +36,8 @@ Properties +---------------------------+----------------------------------------------------------------------------+-----------------+ | :ref:`float` | :ref:`angular_delta_limit` | ``0.034906585`` | +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`bool` | :ref:`deterministic` | ``false`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ | :ref:`int` | :ref:`max_iterations` | ``4`` | +---------------------------+----------------------------------------------------------------------------+-----------------+ | :ref:`float` | :ref:`min_distance` | ``0.001`` | @@ -109,6 +111,25 @@ The maximum amount each bone can rotate in a single iteration. ---- +.. _class_IterateIK3D_property_deterministic: + +.. rst-class:: classref-property + +:ref:`bool` **deterministic** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_deterministic**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deterministic**\ (\ ) + +If ``false``, the result is calculated from the previous frame's **IterateIK3D** result as the initial state. + +If ``true``, the previous frame's **IterateIK3D** result is discarded. At this point, the new result is calculated from the bone pose excluding the **IterateIK3D** as the initial state. This means the result will be always equal as long as the target position and the previous bone pose are the same. However, if :ref:`angular_delta_limit` and :ref:`max_iterations` are set too small, the end bone of the chain will never reach the target. + +.. rst-class:: classref-item-separator + +---- + .. _class_IterateIK3D_property_max_iterations: .. rst-class:: classref-property diff --git a/classes/class_lookatmodifier3d.rst b/classes/class_lookatmodifier3d.rst index b36c347bc80..ee96acce828 100644 --- a/classes/class_lookatmodifier3d.rst +++ b/classes/class_lookatmodifier3d.rst @@ -68,6 +68,8 @@ Properties +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`Axis` | :ref:`primary_rotation_axis` | ``1`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`relative` | ``true`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`secondary_damp_threshold` | | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`secondary_limit_angle` | | @@ -475,6 +477,23 @@ The axis of the first rotation. This :ref:`SkeletonModifier3D` **relative** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_relative**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_relative**\ (\ ) + +The relative option. If ``true``, the rotation is applied relative to the pose. If ``false``, the rotation is applied relative to the rest. It means to replace the current pose with the **LookAtModifier3D**'s result. + +.. rst-class:: classref-item-separator + +---- + .. _class_LookAtModifier3D_property_secondary_damp_threshold: .. rst-class:: classref-property diff --git a/classes/class_node.rst b/classes/class_node.rst index 2b8e6b04c20..7f8c76cd40a 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1910,7 +1910,7 @@ The Tween will start automatically on the next process frame or physics frame (d :ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| :ref:`🔗` -Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags`). Internal nodes are not duplicated. +Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original, recursively. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags`). Internal nodes are not duplicated. \ **Note:** For nodes with a :ref:`Script` attached, if :ref:`Object._init()` has been defined with required parameters, the duplicated node will not have a :ref:`Script`. diff --git a/classes/class_openxrandroidthreadsettingsextension.rst b/classes/class_openxrandroidthreadsettingsextension.rst new file mode 100644 index 00000000000..fac74f2350c --- /dev/null +++ b/classes/class_openxrandroidthreadsettingsextension.rst @@ -0,0 +1,112 @@ +: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/OpenXRAndroidThreadSettingsExtension.xml. + +.. _class_OpenXRAndroidThreadSettingsExtension: + +OpenXRAndroidThreadSettingsExtension +==================================== + +**Inherits:** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +Wraps the `XR_KHR_android_thread_settings `__ extension. + +.. rst-class:: classref-introduction-group + +Description +----------- + +For XR to be comfortable, it is important for applications to deliver frames quickly and consistently. In order to make sure the important application threads get their full share of time, these threads must be identified to the system, which will adjust their scheduling priority accordingly. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_application_thread_type`\ (\ thread_type\: :ref:`ThreadType`, thread_id\: :ref:`int` = 0\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_OpenXRAndroidThreadSettingsExtension_ThreadType: + +.. rst-class:: classref-enumeration + +enum **ThreadType**: :ref:`🔗` + +.. _class_OpenXRAndroidThreadSettingsExtension_constant_THREAD_TYPE_APPLICATION_MAIN: + +.. rst-class:: classref-enumeration-constant + +:ref:`ThreadType` **THREAD_TYPE_APPLICATION_MAIN** = ``0`` + +Hints to the XR runtime that the thread is doing time critical CPU tasks. + +.. _class_OpenXRAndroidThreadSettingsExtension_constant_THREAD_TYPE_APPLICATION_WORKER: + +.. rst-class:: classref-enumeration-constant + +:ref:`ThreadType` **THREAD_TYPE_APPLICATION_WORKER** = ``1`` + +Hints to the XR runtime that the thread is doing background CPU tasks. + +.. _class_OpenXRAndroidThreadSettingsExtension_constant_THREAD_TYPE_RENDERER_MAIN: + +.. rst-class:: classref-enumeration-constant + +:ref:`ThreadType` **THREAD_TYPE_RENDERER_MAIN** = ``2`` + +Hints to the XR runtime that the thread is doing time critical graphics device tasks. + +.. _class_OpenXRAndroidThreadSettingsExtension_constant_THREAD_TYPE_RENDERER_WORKER: + +.. rst-class:: classref-enumeration-constant + +:ref:`ThreadType` **THREAD_TYPE_RENDERER_WORKER** = ``3`` + +Hints to the XR runtime that the thread is doing background graphics device tasks. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_OpenXRAndroidThreadSettingsExtension_method_set_application_thread_type: + +.. rst-class:: classref-method + +:ref:`bool` **set_application_thread_type**\ (\ thread_type\: :ref:`ThreadType`, thread_id\: :ref:`int` = 0\ ) :ref:`🔗` + +Sets the thread type of the given thread, so that the XR runtime can adjust its scheduling priority accordingly. + +\ ``thread_id`` refers to the OS thread id (ie from ``gettid()``). When ``thread_id`` is ``0``, it will set the thread type of the current thread. + +\ **NOTE:** The id returned by :ref:`Thread.get_id()` is incompatible with ``thread_id``. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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_openxrapiextension.rst b/classes/class_openxrapiextension.rst index 13c7f7852a1..e8df73d7324 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -139,6 +139,8 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unregister_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_main_swapchain_size`\ (\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr_result`\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -738,6 +740,18 @@ Unregisters the given extension as a provider of additional data structures to p ---- +.. _class_OpenXRAPIExtension_method_update_main_swapchain_size: + +.. rst-class:: classref-method + +|void| **update_main_swapchain_size**\ (\ ) :ref:`🔗` + +Request the recommended resolution from the OpenXR runtime and update the main swapchain size if it has changed. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_xr_result: .. rst-class:: classref-method diff --git a/classes/class_openxrextensionwrapper.rst b/classes/class_openxrextensionwrapper.rst index 79b09777ece..d77a4405f80 100644 --- a/classes/class_openxrextensionwrapper.rst +++ b/classes/class_openxrextensionwrapper.rst @@ -12,7 +12,7 @@ OpenXRExtensionWrapper **Inherits:** :ref:`Object` -**Inherited By:** :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRFrameSynthesisExtension`, :ref:`OpenXRFutureExtension`, :ref:`OpenXRRenderModelExtension`, :ref:`OpenXRSpatialAnchorCapability`, :ref:`OpenXRSpatialEntityExtension`, :ref:`OpenXRSpatialMarkerTrackingCapability`, :ref:`OpenXRSpatialPlaneTrackingCapability` +**Inherited By:** :ref:`OpenXRAndroidThreadSettingsExtension`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRFrameSynthesisExtension`, :ref:`OpenXRFutureExtension`, :ref:`OpenXRRenderModelExtension`, :ref:`OpenXRSpatialAnchorCapability`, :ref:`OpenXRSpatialEntityExtension`, :ref:`OpenXRSpatialMarkerTrackingCapability`, :ref:`OpenXRSpatialPlaneTrackingCapability` Allows implementing OpenXR extensions with GDExtension. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 14a38b29341..77e86c6e1d9 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -52,7 +52,7 @@ Properties +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`prefer_native_menu` | ``false`` | +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`submenu_popup_delay` | ``0.3`` | + | :ref:`float` | :ref:`submenu_popup_delay` | ``0.2`` | +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`SystemMenus` | :ref:`system_menu_id` | ``0`` | +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -469,7 +469,7 @@ If ``true``, :ref:`MenuBar` will use native menu when supported. .. rst-class:: classref-property -:ref:`float` **submenu_popup_delay** = ``0.3`` :ref:`🔗` +:ref:`float` **submenu_popup_delay** = ``0.2`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -478,6 +478,8 @@ If ``true``, :ref:`MenuBar` will use native menu when supported. Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. +\ **Note:** If the mouse is exiting a submenu item with an open submenu and enters a different submenu item, the submenu popup delay time is affected by the direction of the mouse movement toward the open submenu. If the mouse is moving toward the submenu, the open submenu will wait approximately ``0.5`` seconds before closing, which then allows the hovered submenu item to open. This additional delay allows the mouse time to move to the open submenu across other menu items without prematurely closing. If the mouse is not moving toward the open submenu, for example in a downward direction, the open submenu will close immediately. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 6ddd30b47aa..33e8314dbb3 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -199,14 +199,14 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`debug/gdscript/warnings/directory_rules` | ``{ "res://addons": 0 }`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/empty_file` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/enum_variable_without_default` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/get_node_default_without_onready` | ``2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``1`` | @@ -2032,6 +2032,8 @@ The number of accessibility information updates per second. If ``true``, :ref:`MeshInstance3D.skeleton` will point to the parent node (``..``) by default, which was the behavior before Godot 4.6. It's recommended to keep this setting disabled unless the old behavior is needed for compatibility. +\ **Note:** If you disable this option in an existing project, it's strongly recommended to use the ``Project > Tools > Upgrade Project Files...`` option to ensure existing scenes do not break. + .. rst-class:: classref-item-separator ---- @@ -2924,7 +2926,7 @@ If the ``--log-file `` :doc:`command line argument <../tutorials/editor/co :ref:`int` **debug/gdscript/warnings/assert_always_false** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an ``assert`` call always evaluates to ``false``. +When set to **Warn** or **Error**, produces a warning or an error respectively when an ``assert`` call always evaluates to ``false``. .. rst-class:: classref-item-separator @@ -2936,7 +2938,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/assert_always_true** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an ``assert`` call always evaluates to ``true``. +When set to **Warn** or **Error**, produces a warning or an error respectively when an ``assert`` call always evaluates to ``true``. .. rst-class:: classref-item-separator @@ -2948,7 +2950,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/confusable_capture_reassignment** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a local variable captured by a lambda is reassigned, since this does not modify the outer local variable. +When set to **Warn** or **Error**, produces a warning or an error respectively when a local variable captured by a lambda is reassigned, since this does not modify the outer local variable. .. rst-class:: classref-item-separator @@ -2960,7 +2962,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/confusable_identifier** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier contains characters that can be confused with something else, like when mixing different alphabets. +When set to **Warn** or **Error**, produces a warning or an error respectively when an identifier contains characters that can be confused with something else, like when mixing different alphabets. .. rst-class:: classref-item-separator @@ -2972,7 +2974,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/confusable_local_declaration** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier declared in the nested block has the same name as an identifier declared below in the parent block. +When set to **Warn** or **Error**, produces a warning or an error respectively when an identifier declared in the nested block has the same name as an identifier declared below in the parent block. .. rst-class:: classref-item-separator @@ -2984,7 +2986,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/confusable_local_usage** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an identifier that will be shadowed below in the block is used. +When set to **Warn** or **Error**, produces a warning or an error respectively when an identifier that will be shadowed below in the block is used. .. rst-class:: classref-item-separator @@ -2996,7 +2998,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/deprecated_keyword** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when deprecated keywords are used. +When set to **Warn** or **Error**, produces a warning or an error respectively when deprecated keywords are used. \ **Note:** There are currently no deprecated keywords, so this warning is never produced. @@ -3004,49 +3006,55 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/empty_file: +.. _class_ProjectSettings_property_debug/gdscript/warnings/directory_rules: .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/empty_file** = ``1`` :ref:`🔗` +:ref:`Dictionary` **debug/gdscript/warnings/directory_rules** = ``{ "res://addons": 0 }`` :ref:`🔗` + +The rules for including or excluding scripts when generating warnings, as a dictionary. Each rule is an entry consisting of a directory path (key) and a decision (value). When trying to generate a warning, the GDScript parser chooses the most specific rule, i.e. the most nested directory containing the script. If the decision is **Exclude**, warnings are not generated for this script. If the decision is **Include** or the script doesn't satisfy any of the rules, the warning configuration specified in the Project Settings is applied. -When set to ``warn`` or ``error``, produces a warning or an error respectively when an empty file is parsed. +It is recommended to include your own addons/libraries, either project-specific or actively being developed at the moment. Third-party or project-agnostic addons/libraries should be excluded, as they may be incompatible with the project's warning configuration. + +\ **Note:** It is not recommended to remove or change the rule for ``"res://addons"`` as the project's warning configuration may break third-party addons. Instead, consider including individual addons, if necessary. + +\ **Note:** The editor does not check whether the specified paths are existing directories. It also does not automatically update these paths when directories are moved. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/enable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/empty_file: .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/enable** = ``true`` :ref:`🔗` +:ref:`int` **debug/gdscript/warnings/empty_file** = ``1`` :ref:`🔗` -If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/*`` settings). If ``false``, disables all GDScript warnings. +When set to **Warn** or **Error**, produces a warning or an error respectively when an empty file is parsed. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/enum_variable_without_default: +.. _class_ProjectSettings_property_debug/gdscript/warnings/enable: .. rst-class:: classref-property -:ref:`int` **debug/gdscript/warnings/enum_variable_without_default** = ``1`` :ref:`🔗` +:ref:`bool` **debug/gdscript/warnings/enable** = ``true`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable has an enum type but no explicit default value, but only if the enum does not contain ``0`` as a valid value. +If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/*`` settings). If ``false``, disables all GDScript warnings. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_debug/gdscript/warnings/exclude_addons: +.. _class_ProjectSettings_property_debug/gdscript/warnings/enum_variable_without_default: .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/exclude_addons** = ``true`` :ref:`🔗` +:ref:`int` **debug/gdscript/warnings/enum_variable_without_default** = ``1`` :ref:`🔗` -If ``true``, scripts in the ``res://addons`` folder will not generate warnings. +When set to **Warn** or **Error**, produces a warning or an error respectively when a variable has an enum type but no explicit default value, but only if the enum does not contain ``0`` as a valid value. .. rst-class:: classref-item-separator @@ -3058,7 +3066,7 @@ If ``true``, scripts in the ``res://addons`` folder will not generate warnings. :ref:`int` **debug/gdscript/warnings/get_node_default_without_onready** = ``2`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when :ref:`Node.get_node()` (or the shorthand ``$``) is used as default value of a class variable without the ``@onready`` annotation. +When set to **Warn** or **Error**, produces a warning or an error respectively when :ref:`Node.get_node()` (or the shorthand ``$``) is used as default value of a class variable without the ``@onready`` annotation. .. rst-class:: classref-item-separator @@ -3070,7 +3078,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/incompatible_ternary** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a ternary operator may emit values with incompatible types. +When set to **Warn** or **Error**, produces a warning or an error respectively when a ternary operator may emit values with incompatible types. .. rst-class:: classref-item-separator @@ -3082,7 +3090,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/inference_on_variant** = ``2`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a static inferred type uses a :ref:`Variant` as initial value, which makes the static type to also be Variant. +When set to **Warn** or **Error**, produces a warning or an error respectively when a static inferred type uses a :ref:`Variant` as initial value, which makes the static type to also be Variant. .. rst-class:: classref-item-separator @@ -3094,7 +3102,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/inferred_declaration** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. In GDScript, type inference is performed by declaring a variable with ``:=`` instead of ``=`` and leaving out the type specifier. For example, ``var x := 1`` will *infer* the :ref:`int` type, while ``var x: int = 1`` explicitly declares the variable as :ref:`int`. +When set to **Warn** or **Error**, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. In GDScript, type inference is performed by declaring a variable with ``:=`` instead of ``=`` and leaving out the type specifier. For example, ``var x := 1`` will *infer* the :ref:`int` type, while ``var x: int = 1`` explicitly declares the variable as :ref:`int`. \ **Note:** This warning is recommended *in addition* to :ref:`debug/gdscript/warnings/untyped_declaration` if you want to always specify the type explicitly. Having ``INFERRED_DECLARATION`` warning level higher than ``UNTYPED_DECLARATION`` warning level makes little sense and is not recommended. @@ -3108,7 +3116,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/int_as_enum_without_cast** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when trying to use an integer as an enum without an explicit cast. +When set to **Warn** or **Error**, produces a warning or an error respectively when trying to use an integer as an enum without an explicit cast. .. rst-class:: classref-item-separator @@ -3120,7 +3128,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/int_as_enum_without_match** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when trying to use an integer as an enum when there is no matching enum member for that numeric value. +When set to **Warn** or **Error**, produces a warning or an error respectively when trying to use an integer as an enum when there is no matching enum member for that numeric value. .. rst-class:: classref-item-separator @@ -3132,7 +3140,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/integer_division** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when dividing an integer by another integer (the decimal part will be discarded). +When set to **Warn** or **Error**, produces a warning or an error respectively when dividing an integer by another integer (the decimal part will be discarded). .. rst-class:: classref-item-separator @@ -3144,7 +3152,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/missing_await** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a coroutine without ``await``. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling a coroutine without ``await``. .. rst-class:: classref-item-separator @@ -3156,7 +3164,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/missing_tool** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when the base class script has the ``@tool`` annotation, but the current class script does not have it. +When set to **Warn** or **Error**, produces a warning or an error respectively when the base class script has the ``@tool`` annotation, but the current class script does not have it. .. rst-class:: classref-item-separator @@ -3168,7 +3176,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/narrowing_conversion** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). +When set to **Warn** or **Error**, produces a warning or an error respectively when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). .. rst-class:: classref-item-separator @@ -3180,7 +3188,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/native_method_override** = ``2`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a method in the script overrides a native method, because it may not behave as expected. +When set to **Warn** or **Error**, produces a warning or an error respectively when a method in the script overrides a native method, because it may not behave as expected. .. rst-class:: classref-item-separator @@ -3192,7 +3200,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/onready_with_export** = ``2`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when the ``@onready`` annotation is used together with the ``@export`` annotation, since it may not behave as expected. +When set to **Warn** or **Error**, produces a warning or an error respectively when the ``@onready`` annotation is used together with the ``@export`` annotation, since it may not behave as expected. .. rst-class:: classref-item-separator @@ -3204,7 +3212,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/redundant_await** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a function that is not a coroutine is called with await. +When set to **Warn** or **Error**, produces a warning or an error respectively when a function that is not a coroutine is called with await. .. rst-class:: classref-item-separator @@ -3216,7 +3224,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/redundant_static_unload** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when the ``@static_unload`` annotation is used in a script without any static variables. +When set to **Warn** or **Error**, produces a warning or an error respectively when the ``@static_unload`` annotation is used in a script without any static variables. .. rst-class:: classref-item-separator @@ -3240,7 +3248,7 @@ When enabled, using a property, enum, or function that was renamed since Godot 3 :ref:`int` **debug/gdscript/warnings/return_value_discarded** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a function without using its return value (by assigning it to a variable or using it as a function argument). These return values are sometimes used to indicate possible errors using the :ref:`Error` enum. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling a function without using its return value (by assigning it to a variable or using it as a function argument). These return values are sometimes used to indicate possible errors using the :ref:`Error` enum. .. rst-class:: classref-item-separator @@ -3252,7 +3260,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/shadowed_global_identifier** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when defining a local or member variable, signal, or enum that would have the same name as a built-in function or global class name, thus shadowing it. +When set to **Warn** or **Error**, produces a warning or an error respectively when defining a local or member variable, signal, or enum that would have the same name as a built-in function or global class name, thus shadowing it. .. rst-class:: classref-item-separator @@ -3264,7 +3272,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/shadowed_variable** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a local variable or local constant shadows a member declared in the current class. +When set to **Warn** or **Error**, produces a warning or an error respectively when a local variable or local constant shadows a member declared in the current class. .. rst-class:: classref-item-separator @@ -3276,7 +3284,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/shadowed_variable_base_class** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a local variable or local constant shadows a member declared in a base class. +When set to **Warn** or **Error**, produces a warning or an error respectively when a local variable or local constant shadows a member declared in a base class. .. rst-class:: classref-item-separator @@ -3288,7 +3296,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/standalone_expression** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling an expression that may have no effect on the surrounding code, such as writing ``2 + 2`` as a statement. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling an expression that may have no effect on the surrounding code, such as writing ``2 + 2`` as a statement. .. rst-class:: classref-item-separator @@ -3300,7 +3308,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/standalone_ternary** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a ternary expression that may have no effect on the surrounding code, such as writing ``42 if active else 0`` as a statement. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling a ternary expression that may have no effect on the surrounding code, such as writing ``42 if active else 0`` as a statement. .. rst-class:: classref-item-separator @@ -3312,7 +3320,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/static_called_on_instance** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a static method from an instance of a class instead of from the class directly. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling a static method from an instance of a class instead of from the class directly. .. rst-class:: classref-item-separator @@ -3324,7 +3332,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unassigned_variable** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when using a variable that wasn't previously assigned. +When set to **Warn** or **Error**, produces a warning or an error respectively when using a variable that wasn't previously assigned. .. rst-class:: classref-item-separator @@ -3336,7 +3344,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unassigned_variable_op_assign** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when assigning a variable using an assignment operator like ``+=`` if the variable wasn't previously assigned. +When set to **Warn** or **Error**, produces a warning or an error respectively when assigning a variable using an assignment operator like ``+=`` if the variable wasn't previously assigned. .. rst-class:: classref-item-separator @@ -3348,7 +3356,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unreachable_code** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when unreachable code is detected (such as after a ``return`` statement that will always be executed). +When set to **Warn** or **Error**, produces a warning or an error respectively when unreachable code is detected (such as after a ``return`` statement that will always be executed). .. rst-class:: classref-item-separator @@ -3360,7 +3368,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unreachable_pattern** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when an unreachable ``match`` pattern is detected. +When set to **Warn** or **Error**, produces a warning or an error respectively when an unreachable ``match`` pattern is detected. .. rst-class:: classref-item-separator @@ -3372,7 +3380,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unsafe_call_argument** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when using an expression whose type may not be compatible with the function parameter expected. +When set to **Warn** or **Error**, produces a warning or an error respectively when using an expression whose type may not be compatible with the function parameter expected. .. rst-class:: classref-item-separator @@ -3384,7 +3392,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unsafe_cast** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a :ref:`Variant` value is cast to a non-Variant. +When set to **Warn** or **Error**, produces a warning or an error respectively when a :ref:`Variant` value is cast to a non-Variant. .. rst-class:: classref-item-separator @@ -3396,7 +3404,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unsafe_method_access** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when calling a method whose presence is not guaranteed at compile-time in the class. +When set to **Warn** or **Error**, produces a warning or an error respectively when calling a method whose presence is not guaranteed at compile-time in the class. .. rst-class:: classref-item-separator @@ -3408,7 +3416,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unsafe_property_access** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when accessing a property whose presence is not guaranteed at compile-time in the class. +When set to **Warn** or **Error**, produces a warning or an error respectively when accessing a property whose presence is not guaranteed at compile-time in the class. .. rst-class:: classref-item-separator @@ -3420,7 +3428,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unsafe_void_return** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when returning a call from a ``void`` function when such call cannot be guaranteed to be also ``void``. +When set to **Warn** or **Error**, produces a warning or an error respectively when returning a call from a ``void`` function when such call cannot be guaranteed to be also ``void``. .. rst-class:: classref-item-separator @@ -3432,7 +3440,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/untyped_declaration** = ``0`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable or parameter has no static type, or if a function has no static return type. +When set to **Warn** or **Error**, produces a warning or an error respectively when a variable or parameter has no static type, or if a function has no static return type. \ **Note:** This warning is recommended together with :ref:`EditorSettings.text_editor/completion/add_type_hints` to help achieve type safety. @@ -3446,7 +3454,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_local_constant** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a local constant is never used. +When set to **Warn** or **Error**, produces a warning or an error respectively when a local constant is never used. .. rst-class:: classref-item-separator @@ -3458,7 +3466,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_parameter** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a function parameter is never used. +When set to **Warn** or **Error**, produces a warning or an error respectively when a function parameter is never used. .. rst-class:: classref-item-separator @@ -3470,7 +3478,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_private_class_variable** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a private member variable is never used. +When set to **Warn** or **Error**, produces a warning or an error respectively when a private member variable is never used. .. rst-class:: classref-item-separator @@ -3482,7 +3490,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_signal** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a signal is declared but never explicitly used in the class. +When set to **Warn** or **Error**, produces a warning or an error respectively when a signal is declared but never explicitly used in the class. .. rst-class:: classref-item-separator @@ -3494,7 +3502,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_variable** = ``1`` :ref:`🔗` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a local variable is unused. +When set to **Warn** or **Error**, produces a warning or an error respectively when a local variable is unused. .. rst-class:: classref-item-separator @@ -4780,7 +4788,11 @@ Main window initial position. \ ``1`` - "Primary Screen Center". -\ ``2`` - "Other Screen Center", :ref:`display/window/size/initial_screen` is used to set the screen. +\ ``3`` - "Other Screen Center", :ref:`display/window/size/initial_screen` is used to set the screen. + +\ ``4`` - "Center of Screen With Mouse Pointer". + +\ ``5`` - "Center of Screen With Keyboard Focus". \ **Note:** This setting only affects the exported project, or when the project is run from the command line. In the editor, the value of :ref:`EditorSettings.run/window_placement/rect` is used instead. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 1d8256d7224..882da49e3c4 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -2807,6 +2807,14 @@ Texture can be used as a color attachment in a framebuffer. Texture can be used as a depth/stencil attachment in a framebuffer. +.. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureUsageBits` **TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT** = ``4096`` + +Texture can be used as a depth/stencil resolve attachment in a framebuffer. + .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT: .. rst-class:: classref-enumeration-constant diff --git a/classes/class_skeletonprofilehumanoid.rst b/classes/class_skeletonprofilehumanoid.rst index bc0caa89e85..de72d951d95 100644 --- a/classes/class_skeletonprofilehumanoid.rst +++ b/classes/class_skeletonprofilehumanoid.rst @@ -21,7 +21,7 @@ Description A :ref:`SkeletonProfile` as a preset that is optimized for the human form. This exists for standardization, so all parameters are read-only. -A humanoid skeleton profile contains 54 bones divided in 4 groups: ``"Body"``, ``"Face"``, ``"LeftHand"``, and ``"RightHand"``. It is structured as follows: +A humanoid skeleton profile contains 56 bones divided into 4 groups: ``"Body"``, ``"Face"``, ``"LeftHand"``, and ``"RightHand"``. It is structured as follows: .. code:: text diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index e5141ee2025..820debab4b0 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -68,6 +68,8 @@ Properties +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`custom_arrow_round` | ``false`` | + +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`custom_arrow_step` | ``0.0`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editable` | ``true`` | @@ -197,6 +199,23 @@ Changes the alignment of the underlying :ref:`LineEdit`. ---- +.. _class_SpinBox_property_custom_arrow_round: + +.. rst-class:: classref-property + +:ref:`bool` **custom_arrow_round** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_custom_arrow_round**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_custom_arrow_rounding**\ (\ ) + +If ``true``, the value will be rounded to a multiple of :ref:`custom_arrow_step` when interacting with the arrow buttons. Otherwise, increments the value by :ref:`custom_arrow_step` and then rounds it according to :ref:`Range.step`. + +.. rst-class:: classref-item-separator + +---- + .. _class_SpinBox_property_custom_arrow_step: .. rst-class:: classref-property diff --git a/classes/class_springbonesimulator3d.rst b/classes/class_springbonesimulator3d.rst index d42a7029303..1f7545e1f90 100644 --- a/classes/class_springbonesimulator3d.rst +++ b/classes/class_springbonesimulator3d.rst @@ -41,11 +41,13 @@ Properties .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | - +-------------------------------+----------------------------------------------------------------------------+----------------------+ - | :ref:`int` | :ref:`setting_count` | ``0`` | - +-------------------------------+----------------------------------------------------------------------------+----------------------+ + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -282,6 +284,25 @@ This is useful for effects such as wind and anti-gravity. ---- +.. _class_SpringBoneSimulator3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this **SpringBoneSimulator3D** are ignored. + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_property_setting_count: .. rst-class:: classref-property diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 3f3a2b74642..363cfd9bd50 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -1079,6 +1079,14 @@ Determines whether the ellipsis at the end of the text is enforced and may not b Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag`). +.. _class_TextServer_constant_OVERRUN_SHORT_STRING_ELLIPSIS: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextOverrunFlag` **OVERRUN_SHORT_STRING_ELLIPSIS** = ``32`` + +Determines whether the ellipsis should be added regardless of the string length, otherwise it is added only if the string is 6 characters or longer. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_translationdomain.rst b/classes/class_translationdomain.rst index d3cda84734e..ae4436a8371 100644 --- a/classes/class_translationdomain.rst +++ b/classes/class_translationdomain.rst @@ -61,25 +61,33 @@ Methods .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale_override`\ (\ ) |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_locale_override`\ (\ locale\: :ref:`String`\ ) | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, message_plural\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Translation`\] | :ref:`find_translations`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale_override`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Translation`\] | :ref:`get_translations`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_translation`\ (\ translation\: :ref:`Translation`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_translation_for_locale`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_locale_override`\ (\ locale\: :ref:`String`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, message_plural\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -307,6 +315,18 @@ Removes all translations. ---- +.. _class_TranslationDomain_method_find_translations: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Translation`\] **find_translations**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` + +Returns the :ref:`Translation` instances that match ``locale`` (see :ref:`TranslationServer.compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` will be returned. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_method_get_locale_override: .. rst-class:: classref-method @@ -325,12 +345,50 @@ Returns the locale override of the domain. Returns an empty string if locale ove :ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` +**Deprecated:** Use :ref:`find_translations()` instead. + Returns the :ref:`Translation` instance that best matches ``locale``. Returns ``null`` if there are no matches. .. rst-class:: classref-item-separator ---- +.. _class_TranslationDomain_method_get_translations: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Translation`\] **get_translations**\ (\ ) |const| :ref:`🔗` + +Returns all available :ref:`Translation` instances as added by :ref:`add_translation()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_method_has_translation: + +.. rst-class:: classref-method + +:ref:`bool` **has_translation**\ (\ translation\: :ref:`Translation`\ ) |const| :ref:`🔗` + +Returns ``true`` if this translation domain contains the given ``translation``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_method_has_translation_for_locale: + +.. rst-class:: classref-method + +:ref:`bool` **has_translation_for_locale**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` + +Returns ``true`` if there are any :ref:`Translation` instances that match ``locale`` (see :ref:`TranslationServer.compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` are considered. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_method_pseudolocalize: .. rst-class:: classref-method diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index feb8bb7e606..4d016494521 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -52,63 +52,71 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compare_locales`\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`format_number`\ (\ number\: :ref:`String`, locale\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_countries`\ (\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_languages`\ (\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_scripts`\ (\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_country_name`\ (\ country\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_language_name`\ (\ language\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_loaded_locales`\ (\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale`\ (\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale_name`\ (\ locale\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TranslationDomain` | :ref:`get_or_add_domain`\ (\ domain\: :ref:`StringName`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_percent_sign`\ (\ locale\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_plural_rules`\ (\ locale\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_script_name`\ (\ script\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tool_locale`\ (\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_domain`\ (\ domain\: :ref:`StringName`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`parse_number`\ (\ number\: :ref:`String`, locale\: :ref:`String`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reload_pseudolocalization`\ (\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_domain`\ (\ domain\: :ref:`StringName`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_locale`\ (\ locale\: :ref:`String`\ ) | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`standardize_locale`\ (\ locale\: :ref:`String`, add_defaults\: :ref:`bool` = false\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compare_locales`\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Translation`\] | :ref:`find_translations`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format_number`\ (\ number\: :ref:`String`, locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_countries`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_languages`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_scripts`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_country_name`\ (\ country\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language_name`\ (\ language\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_loaded_locales`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale_name`\ (\ locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TranslationDomain` | :ref:`get_or_add_domain`\ (\ domain\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_percent_sign`\ (\ locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_plural_rules`\ (\ locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_script_name`\ (\ script\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tool_locale`\ (\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Translation`\] | :ref:`get_translations`\ (\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_domain`\ (\ domain\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_translation`\ (\ translation\: :ref:`Translation`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_translation_for_locale`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`parse_number`\ (\ number\: :ref:`String`, locale\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reload_pseudolocalization`\ (\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_domain`\ (\ domain\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_locale`\ (\ locale\: :ref:`String`\ ) | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`standardize_locale`\ (\ locale\: :ref:`String`, add_defaults\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -177,6 +185,18 @@ Compares two locales and returns a similarity score between ``0`` (no match) and ---- +.. _class_TranslationServer_method_find_translations: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Translation`\] **find_translations**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` + +Returns the :ref:`Translation` instances in the main translation domain that match ``locale`` (see :ref:`compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` will be returned. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationServer_method_format_number: .. rst-class:: classref-method @@ -355,12 +375,26 @@ Returns the current locale of the editor. :ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` +**Deprecated:** Use :ref:`find_translations()` instead. + Returns the :ref:`Translation` instance that best matches ``locale`` in the main translation domain. Returns ``null`` if there are no matches. .. rst-class:: classref-item-separator ---- +.. _class_TranslationServer_method_get_translations: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Translation`\] **get_translations**\ (\ ) |const| :ref:`🔗` + +Returns all available :ref:`Translation` instances in the main translation domain as added by :ref:`add_translation()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationServer_method_has_domain: .. rst-class:: classref-method @@ -373,6 +407,30 @@ Returns ``true`` if a translation domain with the specified name exists. ---- +.. _class_TranslationServer_method_has_translation: + +.. rst-class:: classref-method + +:ref:`bool` **has_translation**\ (\ translation\: :ref:`Translation`\ ) |const| :ref:`🔗` + +Returns ``true`` if the main translation domain contains the given ``translation``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationServer_method_has_translation_for_locale: + +.. rst-class:: classref-method + +:ref:`bool` **has_translation_for_locale**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` + +Returns ``true`` if there are any :ref:`Translation` instances in the main translation domain that match ``locale`` (see :ref:`compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` are considered. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationServer_method_parse_number: .. rst-class:: classref-method diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index 21c5c79a45f..484d55b5b68 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -399,9 +399,9 @@ Defining this method is **optional**. If not overridden, it's ``true``. :ref:`bool` **_is_highend**\ (\ ) |virtual| |const| :ref:`🔗` -Override this method to enable high-end mark in the Visual Shader Editor's members dialog. +Override this method to enable the high-end mark in the Visual Shader Editor's members dialog. This should return ``true`` for nodes that only work when using the Forward+ and Mobile renderers. -Defining this method is **optional**. If not overridden, it's ``false``. +Defining this method is **optional**. If not overridden, it's ``false``, which indicates this node works with all renderers (including Compatibility). .. rst-class:: classref-item-separator diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst index fc718db3612..cfa1328d63c 100644 --- a/classes/class_visualshadernodeparameter.rst +++ b/classes/class_visualshadernodeparameter.rst @@ -31,6 +31,8 @@ Properties .. table:: :widths: auto + +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ + | :ref:`int` | :ref:`instance_index` | ``0`` | +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`parameter_name` | ``""`` | +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ @@ -76,11 +78,19 @@ The parameter will use a global value, defined in Project Settings. The parameter will be tied to the node with attached :ref:`ShaderMaterial` using this shader. +.. _class_VisualShaderNodeParameter_constant_QUAL_INSTANCE_INDEX: + +.. rst-class:: classref-enumeration-constant + +:ref:`Qualifier` **QUAL_INSTANCE_INDEX** = ``3`` + +The parameter will be tied to the node with attached :ref:`ShaderMaterial` using this shader. Enables setting a :ref:`instance_index` property. + .. _class_VisualShaderNodeParameter_constant_QUAL_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Qualifier` **QUAL_MAX** = ``3`` +:ref:`Qualifier` **QUAL_MAX** = ``4`` Represents the size of the :ref:`Qualifier` enum. @@ -93,6 +103,23 @@ Represents the size of the :ref:`Qualifier` **instance_index** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_instance_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_instance_index**\ (\ ) + +The index within 0-15 range, which is used to avoid clashes when shader used on multiple materials. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualShaderNodeParameter_property_parameter_name: .. rst-class:: classref-property diff --git a/classes/index.rst b/classes/index.rst index ec28c689c0d..0c2d5d63963 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -870,6 +870,7 @@ Other objects class_offlinemultiplayerpeer class_oggpacketsequenceplayback class_openxranchortracker + class_openxrandroidthreadsettingsextension class_openxrapiextension class_openxrextensionwrapper class_openxrextensionwrapperextension