diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index ee7ff35e9..b2fe12920 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -115,6 +115,8 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`disable_receive_shadows` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`disable_specular_occlusion` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_max_distance` | ``10.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_min_distance` | ``0.0`` | @@ -1111,11 +1113,19 @@ Enables multichannel signed distance field rendering shader. Disables receiving depth-based or volumetric fog. +.. _class_BaseMaterial3D_constant_FLAG_DISABLE_SPECULAR_OCCLUSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_DISABLE_SPECULAR_OCCLUSION** = ``22`` + +Disables specular occlusion. + .. _class_BaseMaterial3D_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Flags` **FLAG_MAX** = ``22`` +:ref:`Flags` **FLAG_MAX** = ``23`` Represents the size of the :ref:`Flags` enum. @@ -1179,6 +1189,10 @@ enum **SpecularMode**: :ref:`🔗` Default specular blob. +\ **Note:** Forward+ uses multiscattering for more accurate reflections, although the impact of multiscattering is more noticeable on rough metallic surfaces than on smooth, non-metallic surfaces. + +\ **Note:** Mobile and Compatibility don't perform multiscattering for performance reasons. Instead, they perform single scattering, which means rough metallic surfaces may look slightly darker than intended. + .. _class_BaseMaterial3D_constant_SPECULAR_TOON: .. rst-class:: classref-enumeration-constant @@ -2034,6 +2048,23 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. ---- +.. _class_BaseMaterial3D_property_disable_specular_occlusion: + +.. rst-class:: classref-property + +:ref:`bool` **disable_specular_occlusion** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +If ``true``, disables specular occlusion even if :ref:`ProjectSettings.rendering/reflections/specular_occlusion/enabled` is ``false``. + +.. rst-class:: classref-item-separator + +---- + .. _class_BaseMaterial3D_property_distance_fade_max_distance: .. rst-class:: classref-property diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index fccb6deb6..aa1e54e7c 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -315,7 +315,7 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u - |void| **set_draw_background**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_background**\ (\ ) -Used by the inspector, set to ``true`` when the property label is drawn. +Used by the inspector, set to ``true`` when the property background is drawn. .. rst-class:: classref-item-separator @@ -332,7 +332,7 @@ Used by the inspector, set to ``true`` when the property label is drawn. - |void| **set_draw_label**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_label**\ (\ ) -Used by the inspector, set to ``true`` when the property background is drawn. +Used by the inspector, set to ``true`` when the property label is drawn. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 5fb59f93c..d4d5e5971 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -449,6 +449,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/code_font_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/collapse_main_menu` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interface/editor/custom_display_scale` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/display_scale` | @@ -881,8 +883,6 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/theme/line_spacing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`version_control/ssh_private_key_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`version_control/ssh_public_key_path` | @@ -3458,6 +3458,22 @@ The size of the font in the script editor. This setting does not impact the font ---- +.. _class_EditorSettings_property_interface/editor/collapse_main_menu: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/collapse_main_menu** :ref:`🔗` + +If ``true``, the main menu collapses into a :ref:`MenuButton`. + +\ **Note:** This setting is only applicable on macOS when :ref:`interface/editor/use_embedded_menu` is ``true``. + +\ **Note:** Defaults to ``true`` on the Android editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/custom_display_scale: .. rst-class:: classref-property @@ -5078,7 +5094,11 @@ If ``true``, tool scripts will be automatically soft-reloaded after they are sav :ref:`bool` **text_editor/behavior/files/auto_reload_scripts_on_external_change** :ref:`🔗` -If ``true``, automatically reloads scripts in the editor when they have been modified and saved by external editors. +If ``true``, automatically reloads scripts and text-based shaders in the editor when they have been modified and saved by external editors or tools and the editor regains focus. External changes can be discarded by using the Undo function after they've been loaded in the editor. + +If ``false``, a file conflict dialog will always be displayed when the editor regains focus. This dialog allows you to choose whether to keep local changes or discard them. + +\ **Note:** Even when this setting is ``true``, a file conflict dialog is still displayed in certain situations. For instance, it will display when the script editor has unsaved changes that the external editor did not account for. .. rst-class:: classref-item-separator @@ -6200,18 +6220,6 @@ The script editor's color for words highlighted by selecting them. Only visible ---- -.. _class_EditorSettings_property_text_editor/theme/line_spacing: - -.. rst-class:: classref-property - -:ref:`int` **text_editor/theme/line_spacing** :ref:`🔗` - -The vertical line separation used in text editors, in pixels. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorSettings_property_version_control/ssh_private_key_path: .. rst-class:: classref-property diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 5de46f172..cb6711c24 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -1265,6 +1265,8 @@ Stores a floating-point number as 32 bits in the file. Stores a half-precision floating-point number as 16 bits in the file. +\ **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index add657a09..010fda026 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -72,7 +72,7 @@ Property Descriptions - |void| **set_action**\ (\ value\: :ref:`StringName`\ ) - :ref:`StringName` **get_action**\ (\ ) -The action's name. Actions are accessed via this :ref:`String`. +The action's name. This is usually the name of an existing action in the :ref:`InputMap` which you want this custom event to match. .. rst-class:: classref-item-separator diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index b29e8c697..21ec091e4 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -321,7 +321,7 @@ enum **BakeMode**: :ref:`🔗` :ref:`BakeMode` **BAKE_DISABLED** = ``0`` -Light is ignored when baking. This is the fastest mode, but the light will be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights. +Light is ignored when baking. This is the fastest mode, but the light will not be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights. \ **Note:** Hiding a light does *not* affect baking :ref:`LightmapGI`. Hiding a light will still affect baking :ref:`VoxelGI` and SDFGI (see :ref:`Environment.sdfgi_enabled`). diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 2a454355c..d23c55e3f 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -167,6 +167,8 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_show_on_focus` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`VirtualKeyboardType` | :ref:`virtual_keyboard_type` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -1260,7 +1262,24 @@ Base text writing direction. - |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) -If ``true``, the native virtual keyboard is shown when focused on platforms that support it. +If ``true``, the native virtual keyboard is enabled on platforms that support it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LineEdit_property_virtual_keyboard_show_on_focus: + +.. rst-class:: classref-property + +:ref:`bool` **virtual_keyboard_show_on_focus** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_virtual_keyboard_show_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_virtual_keyboard_show_on_focus**\ (\ ) + +If ``true``, the native virtual keyboard is shown on focus events on platforms that support it. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index 658b4d439..be7147114 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -585,7 +585,7 @@ The pathfinding algorithm used in the path query. The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by :ref:`neighbor_distance`). -Does not affect normal pathfinding. To change an actor's pathfinding radius bake :ref:`NavigationMesh` resources with a different :ref:`NavigationMesh.agent_radius` property and use different navigation maps for each actor size. +Does not affect normal pathfinding. To change an actor's pathfinding radius bake :ref:`NavigationPolygon` resources with a different :ref:`NavigationPolygon.agent_radius` property and use different navigation maps for each actor size. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index da712445c..18c7110da 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -143,6 +143,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_iteration_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | @@ -997,6 +999,20 @@ Returns the enter cost of this ``link``. ---- +.. _class_NavigationServer2D_method_link_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **link_get_iteration_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the current iteration ID of the navigation link. Every time the navigation link changes and synchronizes, the iteration ID increases. An iteration ID of ``0`` means the navigation link has never synchronized. + +\ **Note:** The iteration ID will wrap around to ``1`` after reaching its range limit. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_link_get_map: .. rst-class:: classref-method diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 03b3afae8..562468c7c 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -151,6 +151,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_iteration_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | @@ -1087,6 +1089,20 @@ Returns the enter cost of this ``link``. ---- +.. _class_NavigationServer3D_method_link_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **link_get_iteration_id**\ (\ link\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the current iteration ID of the navigation link. Every time the navigation link changes and synchronizes, the iteration ID increases. An iteration ID of ``0`` means the navigation link has never synchronized. + +\ **Note:** The iteration ID will wrap around to ``1`` after reaching its range limit. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_link_get_map: .. rst-class:: classref-method diff --git a/classes/class_object.rst b/classes/class_object.rst index e114e4170..b6103dae8 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -521,6 +521,8 @@ Called when the object's script is instantiated, oftentimes after the object is Returns the current iterable value. ``iter`` stores the iteration state, but unlike :ref:`_iter_init()` and :ref:`_iter_next()` the state is supposed to be read-only, so there is no :ref:`Array` wrapper. +\ **Tip:** In GDScript, you can use a subtype of :ref:`Variant` as the return type for :ref:`_iter_get()`. The specified type will be used to set the type of the iterator variable in ``for`` loops, enhancing type safety. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index f46edd08f..1b540f8e5 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -10,6 +10,8 @@ PackedDataContainer =================== +**Deprecated:** Use :ref:`@GlobalScope.var_to_bytes()` or :ref:`FileAccess.store_var()` instead. To enable data compression, use :ref:`PackedByteArray.compress()` or :ref:`FileAccess.open_compressed()`. + **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Efficiently packs and serializes :ref:`Array` or :ref:`Dictionary`. diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 3a88abae3..26ddca447 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -10,6 +10,8 @@ PackedDataContainerRef ====================== +**Deprecated:** Use :ref:`@GlobalScope.var_to_bytes()` or :ref:`FileAccess.store_var()` instead. To enable data compression, use :ref:`PackedByteArray.compress()` or :ref:`FileAccess.open_compressed()`. + **Inherits:** :ref:`RefCounted` **<** :ref:`Object` An internal class used by :ref:`PackedDataContainer` to pack nested arrays and dictionaries. diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 2a71d1f84..3a29de5ce 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -62,6 +62,8 @@ Methods +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_keeping_all_compressed_buffers`\ (\ ) |static| | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_basisu_compressor_params`\ (\ uastc_level\: :ref:`int`, rdo_quality_loss\: :ref:`float`\ ) | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_keep_all_compressed_buffers`\ (\ keep\: :ref:`bool`\ ) |static| | +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -188,6 +190,8 @@ When running on the editor, this class will keep the source compressed data in m This flag allows to keep the compressed data in memory if you intend it to persist after loading. +\ **Note:** This must be set before :ref:`create_from_image()` to take effect. + .. rst-class:: classref-item-separator ---- @@ -266,6 +270,20 @@ Return whether the flag is overridden for all textures of this type. ---- +.. _class_PortableCompressedTexture2D_method_set_basisu_compressor_params: + +.. rst-class:: classref-method + +|void| **set_basisu_compressor_params**\ (\ uastc_level\: :ref:`int`, rdo_quality_loss\: :ref:`float`\ ) :ref:`🔗` + +Sets the compressor parameters for Basis Universal compression. See also the settings in :ref:`ResourceImporterTexture`. + +\ **Note:** This must be set before :ref:`create_from_image()` to take effect. + +.. rst-class:: classref-item-separator + +---- + .. _class_PortableCompressedTexture2D_method_set_keep_all_compressed_buffers: .. rst-class:: classref-method diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 9327a151d..9890fbf9d 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1673,6 +1673,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections.mobile` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/reflections/specular_occlusion/enabled` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method` | ``"forward_plus"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/renderer/rendering_method.mobile` | ``"mobile"`` | @@ -1749,6 +1751,12 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/basis_universal/rdo_dict_size` | ``1024`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/textures/basis_universal/zstd_supercompression` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/basis_universal/zstd_supercompression_level` | ``6`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_filter` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_repeat` | ``0`` | @@ -12492,6 +12500,18 @@ Lower-end override for :ref:`rendering/reflections/sky_reflections/texture_array ---- +.. _class_ProjectSettings_property_rendering/reflections/specular_occlusion/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **rendering/reflections/specular_occlusion/enabled** = ``true`` :ref:`🔗` + +If ``true``, reduces reflections based on ambient light. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/renderer/rendering_method: .. rst-class:: classref-property @@ -13060,6 +13080,44 @@ If ``true``, forces vertex shading for all rendering. This can increase performa ---- +.. _class_ProjectSettings_property_rendering/textures/basis_universal/rdo_dict_size: + +.. rst-class:: classref-property + +:ref:`int` **rendering/textures/basis_universal/rdo_dict_size** = ``1024`` :ref:`🔗` + +The dictionary size for Rate-Distortion Optimization (RDO) when importing textures as Basis Universal and when RDO is enabled, ranging from ``64`` to ``65536``. Higher values reduce the file sizes further, but make encoding times significantly longer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/textures/basis_universal/zstd_supercompression: + +.. rst-class:: classref-property + +:ref:`bool` **rendering/textures/basis_universal/zstd_supercompression** = ``true`` :ref:`🔗` + +If ``true``, enables Zstandard supercompression to reduce file size when importing textures as Basis Universal. + +\ **Note:** Basis Universal textures need to be compressed to gain the benefit of smaller file sizes, otherwise they are as large as VRAM-compressed textures. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/textures/basis_universal/zstd_supercompression_level: + +.. rst-class:: classref-property + +:ref:`int` **rendering/textures/basis_universal/zstd_supercompression_level** = ``6`` :ref:`🔗` + +Specify the compression level for Basis Universal Zstandard supercompression, ranging from ``1`` to ``22``. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/textures/canvas_textures/default_texture_filter: .. rst-class:: classref-property @@ -13646,6 +13704,8 @@ Adds a custom property info to a property. The dictionary must contain: +\ **Note:** Setting ``"usage"`` for the property is not supported. Use :ref:`set_as_basic()`, :ref:`set_restart_if_changed()`, and :ref:`set_as_internal()` to modify usage flags. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 6687c052f..6ecbc6e1f 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -239,7 +239,7 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create`\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create_from_extension`\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) | + | :ref:`RID` | :ref:`texture_create_from_extension`\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int` = 1\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared`\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -6652,9 +6652,9 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) :ref:`🔗` +:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int` = 1\ ) :ref:`🔗` -Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, and ``layers``. This can be used to allow Godot to render onto foreign images. +Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, ``layers``, and ``mipmaps``. This can be used to allow Godot to render onto foreign images. .. rst-class:: classref-item-separator diff --git a/classes/class_resourceimporterlayeredtexture.rst b/classes/class_resourceimporterlayeredtexture.rst index c112d27bb..50e43c910 100644 --- a/classes/class_resourceimporterlayeredtexture.rst +++ b/classes/class_resourceimporterlayeredtexture.rst @@ -36,23 +36,27 @@ Properties .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`compress/mode` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`mipmaps/generate` | ``true`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`slices/arrangement` | ``1`` | - +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/mode` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/rdo_quality_loss` | ``0.0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/uastc_level` | ``0`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`mipmaps/generate` | ``true`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`slices/arrangement` | ``1`` | + +---------------------------+-----------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -153,6 +157,34 @@ See `Compress mode <../tutorials/assets_pipeline/importing_images.html#compress- ---- +.. _class_ResourceImporterLayeredTexture_property_compress/rdo_quality_loss: + +.. rst-class:: classref-property + +:ref:`float` **compress/rdo_quality_loss** = ``0.0`` :ref:`🔗` + +If greater than or equal to ``0.01``, enables Rate-Distortion Optimization (RDO) to reduce file size. Higher values result in smaller file sizes but lower quality. + +\ **Note:** Enabling RDO makes encoding times significantly longer, especially when the image is large. + +See also :ref:`ProjectSettings.rendering/textures/basis_universal/rdo_dict_size` and :ref:`ProjectSettings.rendering/textures/basis_universal/zstd_supercompression_level` if you want to reduce the file size further. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/uastc_level: + +.. rst-class:: classref-property + +:ref:`int` **compress/uastc_level** = ``0`` :ref:`🔗` + +The UASTC encoding level. Higher values result in better quality but make encoding times longer. + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterLayeredTexture_property_mipmaps/generate: .. rst-class:: classref-property diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index 073580dea..2934a7570 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -49,6 +49,10 @@ Properties +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`compress/normal_map` | ``0`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/rdo_quality_loss` | ``0.0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/uastc_level` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`detect_3d/compress_to` | ``1`` | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`editor/convert_colors_with_editor_theme` | ``false`` | @@ -189,6 +193,34 @@ Note that RGTC compression affects the resulting normal map image. You will have ---- +.. _class_ResourceImporterTexture_property_compress/rdo_quality_loss: + +.. rst-class:: classref-property + +:ref:`float` **compress/rdo_quality_loss** = ``0.0`` :ref:`🔗` + +If greater than or equal to ``0.01``, enables Rate-Distortion Optimization (RDO) to reduce file size. Higher values result in smaller file sizes but lower quality. + +\ **Note:** Enabling RDO makes encoding times significantly longer, especially when the image is large. + +See also :ref:`ProjectSettings.rendering/textures/basis_universal/rdo_dict_size` and :ref:`ProjectSettings.rendering/textures/basis_universal/zstd_supercompression_level` if you want to reduce the file size further. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/uastc_level: + +.. rst-class:: classref-property + +:ref:`int` **compress/uastc_level** = ``0`` :ref:`🔗` + +The UASTC encoding level. Higher values result in better quality but make encoding times longer. + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterTexture_property_detect_3d/compress_to: .. rst-class:: classref-property diff --git a/classes/class_scriptbacktrace.rst b/classes/class_scriptbacktrace.rst index 7a9bba502..27f8ff18d 100644 --- a/classes/class_scriptbacktrace.rst +++ b/classes/class_scriptbacktrace.rst @@ -62,6 +62,8 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_member_variable_value`\ (\ frame_index\: :ref:`int`, variable_index\: :ref:`int`\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -262,6 +264,18 @@ Returns the value of the member variable at the specified ``variable_index`` in \ **Warning:** With GDScript backtraces, the returned :ref:`Variant` will be the variable's actual value, including any object references. This means that storing the returned :ref:`Variant` will prevent any such object from being deallocated, so it's generally recommended not to do so. +.. rst-class:: classref-item-separator + +---- + +.. _class_ScriptBacktrace_method_is_empty: + +.. rst-class:: classref-method + +:ref:`bool` **is_empty**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if the backtrace has no stack frames. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_string.rst b/classes/class_string.rst index d43073dc2..26aa98b5a 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -195,7 +195,7 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + | :ref:`String` | :ref:`path_join`\ (\ path\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1547,9 +1547,9 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` +:ref:`String` **path_join**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` -Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. +Concatenates ``path`` at the end of the string as a subpath, adding ``/`` if necessary. \ **Example:** ``"this/is".path_join("path") == "this/is/path"``. diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index b9d518078..4d9f2ee30 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -178,7 +178,7 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + | :ref:`String` | :ref:`path_join`\ (\ path\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1392,9 +1392,9 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| :ref:`🔗` +:ref:`String` **path_join**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` -Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. +Concatenates ``path`` at the end of the string as a subpath, adding ``/`` if necessary. \ **Example:** ``"this/is".path_join("path") == "this/is/path"``. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 540963ed5..9d26ebf46 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -143,6 +143,8 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`virtual_keyboard_show_on_focus` | ``true`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`LineWrappingMode` | :ref:`wrap_mode` | ``0`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -1884,7 +1886,24 @@ If ``false``, using :kbd:`Ctrl + Left` or :kbd:`Ctrl + Right` (:kbd:`Cmd + Left` - |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) -If ``true``, the native virtual keyboard is shown when focused on platforms that support it. +If ``true``, the native virtual keyboard is enabled on platforms that support it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_property_virtual_keyboard_show_on_focus: + +.. rst-class:: classref-property + +:ref:`bool` **virtual_keyboard_show_on_focus** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_virtual_keyboard_show_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_virtual_keyboard_show_on_focus**\ (\ ) + +If ``true``, the native virtual keyboard is shown on focus events on platforms that support it. .. rst-class:: classref-item-separator