From c2e772b74814bbee881751d0e5b9140ee260c51e Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 11 Jan 2025 03:21:17 +0000 Subject: [PATCH] classref: Sync with current master branch (abf8e1e) --- classes/class_@gdscript.rst | 10 +- classes/class_audiostreammp3.rst | 45 ++++++ classes/class_audiostreamoggvorbis.rst | 16 +- classes/class_audiostreamwav.rst | 24 +-- classes/class_basis.rst | 2 +- classes/class_collisionpolygon2d.rst | 2 +- classes/class_colorpicker.rst | 14 -- classes/class_displayserver.rst | 144 +++++++++++++++++- classes/class_editorcontextmenuplugin.rst | 44 +++++- classes/class_editordebuggerplugin.rst | 2 +- classes/class_editorexportplatform.rst | 4 +- .../class_editorexportplatformlinuxbsd.rst | 2 +- classes/class_editorexportplatformweb.rst | 4 +- classes/class_editorexportplatformwindows.rst | 2 - classes/class_editorfiledialog.rst | 2 + classes/class_editorproperty.rst | 38 +++++ classes/class_editorscenepostimportplugin.rst | 2 + classes/class_editorsettings.rst | 28 ++++ classes/class_environment.rst | 12 +- classes/class_filedialog.rst | 4 +- classes/class_itemlist.rst | 37 +++++ classes/class_lightmapgi.rst | 134 ++++++++++------ classes/class_lineedit.rst | 29 +++- classes/class_lookatmodifier3d.rst | 66 +------- classes/class_object.rst | 2 +- classes/class_openxrapiextension.rst | 30 ++++ classes/class_os.rst | 4 +- classes/class_popupmenu.rst | 38 ++--- classes/class_popuppanel.rst | 14 ++ classes/class_projection.rst | 2 + classes/class_projectsettings.rst | 36 ++++- classes/class_renderingdevice.rst | 20 +++ classes/class_renderingserver.rst | 34 ++++- classes/class_resourceimporteroggvorbis.rst | 20 ++- classes/class_richtextlabel.rst | 14 ++ classes/class_skeletonmodifier3d.rst | 65 +++++++- classes/class_subtweentweener.rst | 62 ++++++++ classes/class_textedit.rst | 29 +++- classes/class_textserver.rst | 14 ++ classes/class_textserverextension.rst | 16 ++ classes/class_tilemap.rst | 2 + classes/class_tilemaplayer.rst | 21 +++ classes/class_tween.rst | 31 ++++ classes/class_tweener.rst | 2 +- classes/class_viewport.rst | 34 ++++- classes/class_window.rst | 28 ++++ classes/class_xrvrs.rst | 29 +++- classes/index.rst | 1 + 48 files changed, 1010 insertions(+), 205 deletions(-) create mode 100644 classes/class_subtweentweener.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index ea4a875a148..598bf2ad05e 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1040,6 +1040,8 @@ Converts ``what`` to ``type`` in the best way possible. The ``type`` uses the :r :ref:`Object` **dict_to_inst**\ (\ dictionary\: :ref:`Dictionary`\ ) :ref:`🔗` +**Deprecated:** Consider using :ref:`JSON.to_native` or :ref:`Object.get_property_list` instead. + Converts a ``dictionary`` (created with :ref:`inst_to_dict`) back to an Object instance. Can be useful for deserializing. .. rst-class:: classref-item-separator @@ -1085,9 +1087,9 @@ Starting from ``_ready()``, ``bar()`` would print: :ref:`Dictionary` **inst_to_dict**\ (\ instance\: :ref:`Object`\ ) :ref:`🔗` -Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing. +**Deprecated:** Consider using :ref:`JSON.from_native` or :ref:`Object.get_property_list` instead. -\ **Note:** Cannot be used to serialize objects with built-in scripts attached or objects allocated within built-in scripts. +Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing. :: @@ -1104,6 +1106,10 @@ Prints out: [@subpath, @path, foo] [, res://test.gd, bar] +\ **Note:** This function can only be used to serialize objects with an attached :ref:`GDScript` stored in a separate file. Objects without an attached script, with a script written in another language, or with a built-in script are not supported. + +\ **Note:** This function is not recursive, which means that nested objects will not be represented as dictionaries. Also, properties passed by reference (:ref:`Object`, :ref:`Dictionary`, :ref:`Array`, and packed arrays) are copied by reference, not duplicated. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 9fb45d8369f..cb9fb5f9f83 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -21,6 +21,8 @@ Description MP3 audio stream driver. See :ref:`data` if you want to load an MP3 file at run-time. +\ **Note:** This class can optionally support legacy MP1 and MP2 formats, provided that the engine is compiled with the ``minimp3_extra_formats=yes`` SCons option. These extra formats are not enabled by default. + .. rst-class:: classref-reftable-group Properties @@ -43,6 +45,20 @@ Properties | :ref:`float` | :ref:`loop_offset` | ``0.0`` | +-----------------------------------------------+---------------------------------------------------------------+-----------------------+ +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamMP3` | :ref:`load_from_buffer`\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| | + +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamMP3` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + .. rst-class:: classref-section-separator ---- @@ -183,6 +199,35 @@ If ``true``, the stream will automatically loop when it reaches the end. Time in seconds at which the stream starts after being looped. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_AudioStreamMP3_method_load_from_buffer: + +.. rst-class:: classref-method + +:ref:`AudioStreamMP3` **load_from_buffer**\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` + +Creates a new **AudioStreamMP3** instance from the given buffer. The buffer must contain MP3 data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamMP3_method_load_from_file: + +.. rst-class:: classref-method + +:ref:`AudioStreamMP3` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` + +Creates a new **AudioStreamMP3** instance from the given file path. The file must be in MP3 format. + .. |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_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 7fabed67ccd..9d4bc19a71f 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -58,11 +58,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -190,9 +190,9 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` -Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data. +Creates a new **AudioStreamOggVorbis** instance from the given buffer. The buffer must contain Ogg Vorbis data. .. rst-class:: classref-item-separator @@ -204,7 +204,7 @@ Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer mu :ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` -Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format. +Creates a new **AudioStreamOggVorbis** instance from the given file path. The file must be in Ogg Vorbis format. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index 4bb6e28681b..57f8e6fd738 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -62,13 +62,13 @@ Methods .. table:: :widths: auto - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`load_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| | - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`load_from_file`\ (\ path\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) |static| | - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_to_wav`\ (\ path\: :ref:`String`\ ) | - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`load_from_buffer`\ (\ stream_data\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`load_from_file`\ (\ path\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) |static| | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_to_wav`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -306,11 +306,11 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamWAV` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` +:ref:`AudioStreamWAV` **load_from_buffer**\ (\ stream_data\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` -Creates a new **AudioStreamWAV** instance from the given buffer. The keys and values of ``options`` match the properties of :ref:`ResourceImporterWAV`. +Creates a new **AudioStreamWAV** instance from the given buffer. The buffer must contain WAV data. -The usage of ``options`` is identical to :ref:`load_from_file`. +The keys and values of ``options`` match the properties of :ref:`ResourceImporterWAV`. The usage of ``options`` is identical to :ref:`load_from_file`. .. rst-class:: classref-item-separator @@ -322,7 +322,9 @@ The usage of ``options`` is identical to :ref:`load_from_file` **load_from_file**\ (\ path\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` -Creates a new **AudioStreamWAV** instance from the given file path. The keys and values of ``options`` match the properties of :ref:`ResourceImporterWAV`. +Creates a new **AudioStreamWAV** instance from the given file path. The file must be in WAV format. + +The keys and values of ``options`` match the properties of :ref:`ResourceImporterWAV`. \ **Example:** Load the first file dropped as a WAV and play it: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index f422d31d5c3..9705b3ac45d 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -489,7 +489,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` Returns this basis's rotation as a :ref:`Quaternion`. -\ **Note:** Quatenions are much more suitable for 3D math but are less intuitive. For user interfaces, consider using the :ref:`get_euler` method, which returns Euler angles. +\ **Note:** Quaternions are much more suitable for 3D math but are less intuitive. For user interfaces, consider using the :ref:`get_euler` method, which returns Euler angles. .. rst-class:: classref-item-separator diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index c4e05cd1bf5..e42414e5f63 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -21,7 +21,7 @@ Description A node that provides a polygon shape to a :ref:`CollisionObject2D` parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an :ref:`Area2D`, turn :ref:`PhysicsBody2D` into a solid object, or give a hollow shape to a :ref:`StaticBody2D`. -\ **Warning:** A non-uniformly scaled :ref:`CollisionShape2D` will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead. +\ **Warning:** A non-uniformly scaled **CollisionPolygon2D** will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its polygon instead. .. rst-class:: classref-reftable-group diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 9bbbc4c7710..5e53d4e4b38 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -111,8 +111,6 @@ Theme Properties +-----------------------------------+----------------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`color_hue` | | +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`color_okhsl_hue` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`expanded_arrow` | | +-----------------------------------+----------------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`folded_arrow` | | @@ -668,18 +666,6 @@ Custom texture for the hue selection slider on the right. ---- -.. _class_ColorPicker_theme_icon_color_okhsl_hue: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **color_okhsl_hue** :ref:`🔗` - -Custom texture for the H slider in the OKHSL color mode. - -.. rst-class:: classref-item-separator - ----- - .. _class_ColorPicker_theme_icon_expanded_arrow: .. rst-class:: classref-themeproperty diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 493bc95a07d..0b10e057402 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -272,6 +272,8 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_emoji_and_symbol_picker`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | @@ -408,6 +410,8 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`window_start_drag`\ (\ window_id\: :ref:`int` = 0\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_start_resize`\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -658,6 +662,22 @@ Display server supports :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE` **FEATURE_NATIVE_DIALOG_FILE_MIME** = ``30`` + +Native file selection dialog supports MIME types as filters. + +.. _class_DisplayServer_constant_FEATURE_EMOJI_AND_SYMBOL_PICKER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_EMOJI_AND_SYMBOL_PICKER** = ``31`` + +Display server supports system emoji and symbol picker. **Windows, macOS** + .. rst-class:: classref-item-separator ---- @@ -1126,6 +1146,8 @@ Full screen window covers the entire display area of a screen and has no border \ **On Linux (X11):** Exclusive full screen mode bypasses compositor. +\ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN`. + \ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode. .. rst-class:: classref-item-separator @@ -1326,6 +1348,88 @@ Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXT ---- +.. _enum_DisplayServer_WindowResizeEdge: + +.. rst-class:: classref-enumeration + +enum **WindowResizeEdge**: :ref:`🔗` + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_LEFT** = ``0`` + +Top-left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP** = ``1`` + +Top edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_RIGHT** = ``2`` + +Top-right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_LEFT** = ``3`` + +Left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_RIGHT** = ``4`` + +Right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_LEFT** = ``5`` + +Bottom-left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM** = ``6`` + +Bottom edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7`` + +Bottom-right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_MAX** = ``8`` + +Represents the size of the :ref:`WindowResizeEdge` enum. + +.. rst-class:: classref-item-separator + +---- + .. _enum_DisplayServer_VSyncMode: .. rst-class:: classref-enumeration @@ -1808,7 +1912,7 @@ Allows the ``process_id`` PID to steal focus from this window. In other words, t Displays OS native dialog for selecting files or directories in the file system. -Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters`. +Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters`. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero. @@ -1816,7 +1920,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt \ **Note:** ``current_directory`` might be ignored. -\ **Note:** On Android, the filter strings in the ``filters`` array should be specified using MIME types, for example:``image/png, image/jpeg"``. Additionally, the ``mode`` :ref:`FILE_DIALOG_MODE_OPEN_ANY` is not supported on Android. +\ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. \ **Note:** On Android and Linux, ``show_hidden`` is ignored. @@ -1836,7 +1940,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. -Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters`. +Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters`. \ ``options`` is array of :ref:`Dictionary`\ s with the following keys: @@ -1852,6 +1956,8 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt \ **Note:** ``current_directory`` might be ignored. +\ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. + \ **Note:** On Linux (X11), ``show_hidden`` is ignored. \ **Note:** On macOS, native file dialogs have no title. @@ -3577,6 +3683,20 @@ Sets the ``callable`` that should be called when system theme settings are chang ---- +.. _class_DisplayServer_method_show_emoji_and_symbol_picker: + +.. rst-class:: classref-method + +|void| **show_emoji_and_symbol_picker**\ (\ ) |const| :ref:`🔗` + +Opens system emoji and symbol picker. + +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_status_indicator_get_rect: .. rst-class:: classref-method @@ -4603,9 +4723,23 @@ Sets the ``callback`` that will be called when an event occurs in the window spe |void| **window_start_drag**\ (\ window_id\: :ref:`int` = 0\ ) :ref:`🔗` -Starts a drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features. +Starts an interactive drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features. + +\ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_window_start_resize: -\ **Note:** This method is implemented on Linux(X11/Wayland), macOS, and Windows. +.. rst-class:: classref-method + +|void| **window_start_resize**\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) :ref:`🔗` + +Starts an interactive resize operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge. + +\ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_editorcontextmenuplugin.rst b/classes/class_editorcontextmenuplugin.rst index 51586bc9b07..b23cd3938cb 100644 --- a/classes/class_editorcontextmenuplugin.rst +++ b/classes/class_editorcontextmenuplugin.rst @@ -74,6 +74,14 @@ Context menu of Scene dock. :ref:`_popup_menu` and option callback will be called with list of paths of the currently selected files. +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCRIPT_EDITOR** = ``2`` + +Context menu of Script editor's script tabs. :ref:`_popup_menu` will be called with the path to the currently edited script, while option callback will receive reference to that script. + .. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_FILESYSTEM_CREATE: .. rst-class:: classref-enumeration-constant @@ -82,13 +90,43 @@ Context menu of FileSystem dock. :ref:`_popup_menu` and option callback will be called with list of paths of the currently selected files. -.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR: +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCRIPT_EDITOR_CODE: .. rst-class:: classref-enumeration-constant -:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCRIPT_EDITOR** = ``2`` +:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCRIPT_EDITOR_CODE** = ``4`` + +Context menu of Script editor's code editor. :ref:`_popup_menu` will be called with the path to the :ref:`CodeEdit` node. You can fetch it using this code: + +:: + + func _popup_menu(paths): + var code_edit = Engine.get_main_loop().root.get_node(paths[0]); + +The option callback will receive reference to that node. You can use :ref:`CodeEdit` methods to perform symbol lookups etc. + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_SCENE_TABS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_SCENE_TABS** = ``5`` + +Context menu of scene tabs. :ref:`_popup_menu` will be called with the path of the clicked scene, or empty :ref:`PackedStringArray` if the menu was opened on empty space. The option callback will receive the path of the clicked scene, or empty :ref:`String` if none was clicked. + +.. _class_EditorContextMenuPlugin_constant_CONTEXT_SLOT_2D_EDITOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ContextMenuSlot` **CONTEXT_SLOT_2D_EDITOR** = ``6`` + +Context menu of 2D editor's basic right-click menu. :ref:`_popup_menu` will be called with paths to all :ref:`CanvasItem` nodes under the cursor. You can fetch them using this code: + +:: + + func _popup_menu(paths): + var canvas_item = Engine.get_main_loop().root.get_node(paths[0]); # Replace 0 with the desired index. -Context menu of Scene dock. :ref:`_popup_menu` will be called with the path to the currently edited script, while option callback will receive reference to that script. +The paths array is empty if there weren't any nodes under cursor. The option callback will receive a typed array of :ref:`CanvasItem` nodes. .. rst-class:: classref-section-separator diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 366b187a465..1f611d20bb6 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -181,7 +181,7 @@ Override this method to be notified when a breakpoint line has been clicked in t :ref:`bool` **_has_capture**\ (\ capture\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passes to the :ref:`_capture` method. +Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passed to the :ref:`_capture` method. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 2a4588800e6..7d6119af192 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -67,7 +67,7 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_forced_export_files`\ (\ ) |static| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_internal_export_files`\ (\ ) |static| | + | :ref:`Dictionary` | :ref:`get_internal_export_files`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_message_category`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -372,7 +372,7 @@ Returns array of core file names that always should be exported regardless of pr .. rst-class:: classref-method -:ref:`Dictionary` **get_internal_export_files**\ (\ ) |static| :ref:`🔗` +:ref:`Dictionary` **get_internal_export_files**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) :ref:`🔗` Returns additional files that should always be exported regardless of preset configuration, and are not part of the project source. The returned :ref:`Dictionary` contains filename keys (:ref:`String`) and their corresponding raw data (:ref:`PackedByteArray`). diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 57c7865959e..f95fd35c130 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -78,7 +78,7 @@ Application executable architecture. Supported architectures: ``x86_32``, ``x86_64``, ``arm64``, ``arm32``, ``rv64``, ``ppc64``, ``ppc32``, and ``loongarch64``. -Official export templates include ``x86_32`` and ``x86_64`` binaries only. +Official export templates include ``x86_32``, ``x86_64``, ``arm32``, and ``arm64`` binaries only. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index 286a5787efa..753d1290c7f 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -363,7 +363,7 @@ If ``false``, the exported game will not support threads. As a result, it is mor :ref:`bool` **vram_texture_compression/for_desktop** :ref:`🔗` -If ``true``, allows textures to be optimized for desktop through the S3TC algorithm. +If ``true``, allows textures to be optimized for desktop through the S3TC/BPTC algorithm. .. rst-class:: classref-item-separator @@ -375,7 +375,7 @@ If ``true``, allows textures to be optimized for desktop through the S3TC algori :ref:`bool` **vram_texture_compression/for_mobile** :ref:`🔗` -If ``true`` allows textures to be optimized for mobile through the ETC2 algorithm. +If ``true`` allows textures to be optimized for mobile through the ETC2/ASTC algorithm. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index d9041fcafcf..a6265d7128b 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -299,8 +299,6 @@ Application executable architecture. Supported architectures: ``x86_32``, ``x86_64``, and ``arm64``. -Official export templates include ``x86_32`` and ``x86_64`` binaries only. - .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 35c57c2a0cd..4d363af0ebd 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -21,6 +21,8 @@ Description **EditorFileDialog** is an enhanced version of :ref:`FileDialog` available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list. +Unlike :ref:`FileDialog`, **EditorFileDialog** does not have a property for using native dialogs. Instead, native dialogs can be enabled globally via the :ref:`EditorSettings.interface/editor/use_native_file_dialogs` editor setting. They are also enabled automatically when running in sandbox (e.g. on macOS). + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index d227c75c2ac..9c7eb2ee994 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -36,6 +36,10 @@ Properties +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`deletable` | ``false`` | +-----------------------------+-------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`draw_background` | ``true`` | + +-----------------------------+-------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`draw_label` | ``true`` | + +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`draw_warning` | ``false`` | +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`keying` | ``false`` | @@ -298,6 +302,40 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u ---- +.. _class_EditorProperty_property_draw_background: + +.. rst-class:: classref-property + +:ref:`bool` **draw_background** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |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. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorProperty_property_draw_label: + +.. rst-class:: classref-property + +:ref:`bool` **draw_label** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |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. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorProperty_property_draw_warning: .. rst-class:: classref-property diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index 8e8e6321c41..44b2e6f5791 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -265,6 +265,8 @@ Post process the scene. This function is called after the final scene has been c Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. +Pre process may be used to adjust internal import options in the ``"nodes"``, ``"meshes"``, ``"animations"`` or ``"materials"`` keys inside ``get_option_value("_subresources")``. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 1c3d3fbca99..e113c98492e 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -97,6 +97,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/hide_filtered_out_parents` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/start_create_dialog_fully_expanded` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/2d/bone_color1` | @@ -213,6 +215,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/fog_volume` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/gridmap_grid` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | @@ -1173,6 +1177,18 @@ If ``true``, new node created when reparenting node(s) will be positioned at the ---- +.. _class_EditorSettings_property_docks/scene_tree/hide_filtered_out_parents: + +.. rst-class:: classref-property + +:ref:`bool` **docks/scene_tree/hide_filtered_out_parents** :ref:`🔗` + +If ``true``, the scene tree dock will only show nodes that match the filter, without showing parents that don't. This settings can also be changed in the Scene dock's top menu. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_docks/scene_tree/start_create_dialog_fully_expanded: .. rst-class:: classref-property @@ -1903,6 +1919,18 @@ The 3D editor gizmo color for :ref:`FogVolume` nodes. ---- +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/gridmap_grid: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/gridmap_grid** :ref:`🔗` + +The 3D editor gizmo color for the :ref:`GridMap` grid. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated: .. rst-class:: classref-property diff --git a/classes/class_environment.rst b/classes/class_environment.rst index f535aa955cb..15809ae4ac4 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -453,6 +453,14 @@ Use the Academy Color Encoding System tonemapper. ACES is slightly more expensiv \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x. +.. _class_Environment_constant_TONE_MAPPER_AGX: + +.. rst-class:: classref-enumeration-constant + +:ref:`ToneMapper` **TONE_MAPPER_AGX** = ``4`` + +Use the AgX tonemapper. AgX is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. AgX is less likely to darken parts of the scene compared to :ref:`TONE_MAPPER_ACES` and can match the overall scene brightness of :ref:`TONE_MAPPER_FILMIC` more closely. + .. rst-class:: classref-item-separator ---- @@ -2077,7 +2085,9 @@ The tonemapping mode to use. Tonemapping is the process that "converts" HDR valu - |void| **set_tonemap_white**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_tonemap_white**\ (\ ) -The white reference value for tonemapping (also called "whitepoint"). Higher values can make highlights look less blown out, and will also slightly darken the whole scene as a result. Only effective if the :ref:`tonemap_mode` isn't set to :ref:`TONE_MAPPER_LINEAR`. See also :ref:`tonemap_exposure`. +The white reference value for tonemapping (also called "whitepoint"). Higher values can make highlights look less blown out, and will also slightly darken the whole scene as a result. See also :ref:`tonemap_exposure`. + +\ **Note:** :ref:`tonemap_white` is ignored when using :ref:`TONE_MAPPER_LINEAR` or :ref:`TONE_MAPPER_AGX`. .. rst-class:: classref-item-separator diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index a6402cac45d..d8168caa12e 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -405,9 +405,9 @@ See also :ref:`filters`, which should be used - |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`PackedStringArray` **get_filters**\ (\ ) -The available file type filters. Each filter string in the array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. +The available file type filters. Each filter string in the array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. -\ **Note:** For android native dialog, MIME types are used like this: ``image/*, application/pdf``. +\ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index e8391893865..84ad6fb8586 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -72,6 +72,8 @@ Properties +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`OverrunBehavior` | :ref:`text_overrun_behavior` | ``3`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`wraparound_items` | ``true`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -96,6 +98,8 @@ Methods +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_update_list_size`\ (\ ) | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HScrollBar` | :ref:`get_h_scroll_bar`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_at_position`\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AutoTranslateMode` | :ref:`get_item_auto_translate_mode`\ (\ idx\: :ref:`int`\ ) |const| | @@ -639,6 +643,25 @@ Allows single or multiple item selection. See the :ref:`SelectMode` for a description of all modes. +.. rst-class:: classref-item-separator + +---- + +.. _class_ItemList_property_wraparound_items: + +.. rst-class:: classref-property + +:ref:`bool` **wraparound_items** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_wraparound_items**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_wraparound_items**\ (\ ) + +If ``true``, the control will automatically move items into a new row to fit its content. See also :ref:`HFlowContainer` for this behavior. + +If ``false``, the control will add a horizontal scrollbar to make all items visible. + .. rst-class:: classref-section-separator ---- @@ -736,6 +759,20 @@ Forces an update to the list size based on its items. This happens automatically ---- +.. _class_ItemList_method_get_h_scroll_bar: + +.. rst-class:: classref-method + +:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) :ref:`🔗` + +Returns the horizontal scrollbar. + +\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_method_get_item_at_position: .. rst-class:: classref-method diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index 337db2a21c2..c5f38c34937 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -48,47 +48,51 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`bias` | ``0.0005`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`bounce_indirect_energy` | ``1.0`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`int` | :ref:`bounces` | ``3`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`CameraAttributes` | :ref:`camera_attributes` | | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`int` | :ref:`denoiser_range` | ``10`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`denoiser_strength` | ``0.1`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`directional` | ``false`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`Color` | :ref:`environment_custom_color` | | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`environment_custom_energy` | | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`Sky` | :ref:`environment_custom_sky` | | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`EnvironmentMode` | :ref:`environment_mode` | ``1`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`GenerateProbes` | :ref:`generate_probes_subdiv` | ``2`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`interior` | ``false`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`LightmapGIData` | :ref:`light_data` | | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`int` | :ref:`max_texture_size` | ``16384`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`BakeQuality` | :ref:`quality` | ``1`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`ShadowmaskMode` | :ref:`shadowmask_mode` | ``0`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`texel_scale` | ``1.0`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`use_denoiser` | ``true`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`use_texture_for_bounces` | ``true`` | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`bias` | ``0.0005`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`bounce_indirect_energy` | ``1.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`bounces` | ``3`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`CameraAttributes` | :ref:`camera_attributes` | | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`denoiser_range` | ``10`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`denoiser_strength` | ``0.1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`directional` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`environment_custom_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`environment_custom_energy` | ``1.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Sky` | :ref:`environment_custom_sky` | | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`EnvironmentMode` | :ref:`environment_mode` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`GenerateProbes` | :ref:`generate_probes_subdiv` | ``2`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`interior` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`LightmapGIData` | :ref:`light_data` | | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`max_texture_size` | ``16384`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`BakeQuality` | :ref:`quality` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`ShadowmaskMode` | :ref:`shadowmask_mode` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`supersampling` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`supersampling_factor` | ``2.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`texel_scale` | ``1.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`use_denoiser` | ``true`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`use_texture_for_bounces` | ``true`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -473,7 +477,7 @@ If ``true``, bakes lightmaps to contain directional information as spherical har .. rst-class:: classref-property -:ref:`Color` **environment_custom_color** :ref:`🔗` +:ref:`Color` **environment_custom_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -490,7 +494,7 @@ The color to use for environment lighting. Only effective if :ref:`environment_m .. rst-class:: classref-property -:ref:`float` **environment_custom_energy** :ref:`🔗` +:ref:`float` **environment_custom_energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget @@ -622,7 +626,9 @@ The maximum texture size for the generated texture atlas. Higher values will res The quality preset to use when baking lightmaps. This affects bake times, but output file sizes remain mostly identical across quality levels. -To further speed up bake times, decrease :ref:`bounces`, disable :ref:`use_denoiser` and increase the lightmap texel size on 3D scenes in the Import dock. +To further speed up bake times, decrease :ref:`bounces`, disable :ref:`use_denoiser` and/or decrease :ref:`texel_scale`. + +To further increase quality, enable :ref:`supersampling` and/or increase :ref:`texel_scale`. .. rst-class:: classref-item-separator @@ -651,6 +657,46 @@ Shadowmasking allows :ref:`DirectionalLight3D` nodes t ---- +.. _class_LightmapGI_property_supersampling: + +.. rst-class:: classref-property + +:ref:`bool` **supersampling** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_supersampling_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_supersampling_enabled**\ (\ ) + +If ``true``, lightmaps are baked with the texel scale multiplied with :ref:`supersampling_factor` and downsampled before saving the lightmap (so the effective texel density is identical to having supersampling disabled). + +Supersampling provides increased lightmap quality with less noise, smoother shadows and better shadowing of small-scale features in objects. However, it may result in significantly increased bake times and memory usage while baking lightmaps. Padding is automatically adjusted to avoid increasing light leaking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LightmapGI_property_supersampling_factor: + +.. rst-class:: classref-property + +:ref:`float` **supersampling_factor** = ``2.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_supersampling_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_supersampling_factor**\ (\ ) + +The factor by which the texel density is multiplied for supersampling. For best results, use an integer value. While fractional values are allowed, they can result in increased light leaking and a blurry lightmap. + +Higher values may result in better quality, but also increase bake times and memory usage while baking. + +See :ref:`supersampling` for more information. + +.. rst-class:: classref-item-separator + +---- + .. _class_LightmapGI_property_texel_scale: .. rst-class:: classref-property diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 10ae4fc19af..bfcd6428183 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -115,6 +115,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editable` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`expand_to_text_length` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`flat` | ``false`` | @@ -570,11 +572,19 @@ Inserts word joiner (WJ) character. Inserts soft hyphen (SHY) character. +.. _class_LineEdit_constant_MENU_EMOJI_AND_SYMBOL: + +.. rst-class:: classref-enumeration-constant + +:ref:`MenuItems` **MENU_EMOJI_AND_SYMBOL** = ``30`` + +Opens system emoji and symbol picker. + .. _class_LineEdit_constant_MENU_MAX: .. rst-class:: classref-enumeration-constant -:ref:`MenuItems` **MENU_MAX** = ``30`` +:ref:`MenuItems` **MENU_MAX** = ``31`` Represents the size of the :ref:`MenuItems` enum. @@ -869,6 +879,23 @@ If ``false``, existing text cannot be modified and new text cannot be added. ---- +.. _class_LineEdit_property_emoji_menu_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **emoji_menu_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_emoji_menu_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emoji_menu_enabled**\ (\ ) + +If ``false``, "Emoji and Symbols" menu is enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_property_expand_to_text_length: .. rst-class:: classref-property diff --git a/classes/class_lookatmodifier3d.rst b/classes/class_lookatmodifier3d.rst index 89a3ee6e207..0cb0e553012 100644 --- a/classes/class_lookatmodifier3d.rst +++ b/classes/class_lookatmodifier3d.rst @@ -40,7 +40,7 @@ Properties +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`EaseType` | :ref:`ease_type` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`BoneAxis` | :ref:`forward_axis` | ``4`` | + | :ref:`BoneAxis` | :ref:`forward_axis` | ``4`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`origin_bone` | | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ @@ -116,64 +116,6 @@ Methods Enumerations ------------ -.. _enum_LookAtModifier3D_BoneAxis: - -.. rst-class:: classref-enumeration - -enum **BoneAxis**: :ref:`🔗` - -.. _class_LookAtModifier3D_constant_BONE_AXIS_PLUS_X: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_PLUS_X** = ``0`` - -Enumerated value for the +X axis. - -.. _class_LookAtModifier3D_constant_BONE_AXIS_MINUS_X: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_MINUS_X** = ``1`` - -Enumerated value for the -X axis. - -.. _class_LookAtModifier3D_constant_BONE_AXIS_PLUS_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_PLUS_Y** = ``2`` - -Enumerated value for the +Y axis. - -.. _class_LookAtModifier3D_constant_BONE_AXIS_MINUS_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_MINUS_Y** = ``3`` - -Enumerated value for the -Y axis. - -.. _class_LookAtModifier3D_constant_BONE_AXIS_PLUS_Z: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_PLUS_Z** = ``4`` - -Enumerated value for the +Z axis. - -.. _class_LookAtModifier3D_constant_BONE_AXIS_MINUS_Z: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneAxis` **BONE_AXIS_MINUS_Z** = ``5`` - -Enumerated value for the -Z axis. - -.. rst-class:: classref-item-separator - ----- - .. _enum_LookAtModifier3D_OriginFrom: .. rst-class:: classref-enumeration @@ -295,12 +237,12 @@ The ease type of the time-based interpolation. See also :ref:`EaseType` **forward_axis** = ``4`` :ref:`🔗` +:ref:`BoneAxis` **forward_axis** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget -- |void| **set_forward_axis**\ (\ value\: :ref:`BoneAxis`\ ) -- :ref:`BoneAxis` **get_forward_axis**\ (\ ) +- |void| **set_forward_axis**\ (\ value\: :ref:`BoneAxis`\ ) +- :ref:`BoneAxis` **get_forward_axis**\ (\ ) The forward axis of the bone. This :ref:`SkeletonModifier3D` modifies the bone so that this axis points toward the :ref:`target_node`. diff --git a/classes/class_object.rst b/classes/class_object.rst index 4478b872264..f28d3a87ff8 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -1311,7 +1311,7 @@ Returns the object's metadata value for the given entry ``name``. If the entry d :ref:`Array`\[:ref:`StringName`\] **get_meta_list**\ (\ ) |const| :ref:`🔗` -Returns the object's metadata entry names as a :ref:`PackedStringArray`. +Returns the object's metadata entry names as an :ref:`Array` of :ref:`StringName`\ s. .. rst-class:: classref-item-separator diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index 705e491b226..ead58327bd6 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -71,6 +71,8 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_predicted_display_time`\ (\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_projection_layer`\ (\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_render_state_z_far`\ (\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_render_state_z_near`\ (\ ) | @@ -113,6 +115,8 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_object_name`\ (\ object_type\: :ref:`int`, object_handle\: :ref:`int`, object_name\: :ref:`String`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_render_region`\ (\ render_region\: :ref:`Rect2i`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_velocity_depth_texture`\ (\ render_target\: :ref:`RID`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_velocity_target_size`\ (\ target_size\: :ref:`Vector2i`\ ) | @@ -298,6 +302,20 @@ Returns the predicted display timing for the current frame. ---- +.. _class_OpenXRAPIExtension_method_get_projection_layer: + +.. rst-class:: classref-method + +:ref:`int` **get_projection_layer**\ (\ ) :ref:`🔗` + +Returns a pointer to the render state's ``XrCompositionLayerProjection`` struct. + +\ **Note:** This method should only be called from the rendering thread. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_get_render_state_z_far: .. rst-class:: classref-method @@ -554,6 +572,18 @@ Set the object name of an OpenXR object, used for debug output. ``object_type`` ---- +.. _class_OpenXRAPIExtension_method_set_render_region: + +.. rst-class:: classref-method + +|void| **set_render_region**\ (\ render_region\: :ref:`Rect2i`\ ) :ref:`🔗` + +Sets the render region to ``render_region``, overriding the normal render target's rect. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_set_velocity_depth_texture: .. rst-class:: classref-method diff --git a/classes/class_os.rst b/classes/class_os.rst index 7ac24fd643e..2c59dd32682 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1827,7 +1827,9 @@ This can useful when files may be opened by other applications, such as antiviru Requests the OS to open a resource identified by ``uri`` with the most appropriate program. For example: -- ``OS.shell_open("C:\\Users\name\Downloads")`` on Windows opens the file explorer at the user's Downloads folder. +- ``OS.shell_open("C:\\Users\\name\\Downloads")`` on Windows opens the file explorer at the user's Downloads folder. + +- ``OS.shell_open("C:/Users/name/Downloads")`` also works on Windows and opens the file explorer at the user's Downloads folder. - ``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index a0241632517..4f2e28bc0f0 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -37,23 +37,27 @@ Properties .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`allow_search` | ``true`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`hide_on_checkable_item_selection` | ``true`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`hide_on_item_selection` | ``true`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`hide_on_state_item_selection` | ``false`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`item_count` | ``0`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`prefer_native_menu` | ``false`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`submenu_popup_delay` | ``0.3`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`SystemMenus` | :ref:`system_menu_id` | ``0`` | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_on_checkable_item_selection` | ``true`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_on_item_selection` | ``true`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_on_state_item_selection` | ``false`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`item_count` | ``0`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`prefer_native_menu` | ``false`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`submenu_popup_delay` | ``0.3`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`SystemMenus` | :ref:`system_menu_id` | ``0`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | transparent | ``true`` (overrides :ref:`Window`) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | transparent_bg | ``true`` (overrides :ref:`Viewport`) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index b58dcc0bb73..3975c2933aa 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -23,6 +23,20 @@ A popup with a configurable panel background. Any child controls added to this n .. rst-class:: classref-reftable-group +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+----------------+------------------------------------------------------------------------------+ + | :ref:`bool` | transparent | ``true`` (overrides :ref:`Window`) | + +-------------------------+----------------+------------------------------------------------------------------------------+ + | :ref:`bool` | transparent_bg | ``true`` (overrides :ref:`Viewport`) | + +-------------------------+----------------+------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + Theme Properties ---------------- diff --git a/classes/class_projection.rst b/classes/class_projection.rst index 0bfdeeaac13..339dd37ec70 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -546,6 +546,8 @@ Returns the horizontal field of view of the projection (in degrees). Returns the vertical field of view of the projection (in degrees) associated with the given horizontal field of view (in degrees) and aspect ratio. +\ **Note:** Unlike most methods of **Projection**, ``aspect`` is expected to be 1 divided by the X:Y aspect ratio. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 22d2c202572..5540ce251b1 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -229,7 +229,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/redundant_static_unload` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/renamed_in_godot_4_hint` | ``1`` | + | :ref:`bool` | :ref:`debug/gdscript/warnings/renamed_in_godot_4_hint` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1649,6 +1649,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/scaling_3d/mode` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/scaling_3d/mode.ios` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/scaling_3d/mode.macos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/scaling_3d/scale` | ``1.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/compress` | ``true`` | @@ -3008,7 +3012,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/renamed_in_godot_4_hint** = ``1`` :ref:`🔗` +:ref:`bool` **debug/gdscript/warnings/renamed_in_godot_4_hint** = ``true`` :ref:`🔗` When enabled, using a property, enum, or function that was renamed since Godot 3 will produce a hint if an error occurs. @@ -10164,6 +10168,8 @@ If ``true``, enables the body pair contact cache, which removes the need for pot The minimum velocity needed before a collision can be bouncy, in meters per second. +\ **Note:** This setting will only be read once during the lifetime of the application. + .. rst-class:: classref-item-separator ---- @@ -12026,7 +12032,7 @@ If ``true``, the forward renderer will fall back to Direct3D 12 if Vulkan is not :ref:`bool` **rendering/rendering_device/fallback_to_opengl3** = ``true`` :ref:`🔗` -If ``true``, the forward renderer will fall back to OpenGL 3 if both Direct3D 12, Metal and Vulkan are not supported. +If ``true``, the forward renderer will fall back to OpenGL 3 if Direct3D 12, Metal, and Vulkan are not supported. \ **Note:** This setting is implemented only on Windows, Android, macOS, iOS, and Linux/X11. @@ -12216,6 +12222,30 @@ Sets the scaling 3D mode. Bilinear scaling renders at different resolution to ei ---- +.. _class_ProjectSettings_property_rendering/scaling_3d/mode.ios: + +.. rst-class:: classref-property + +:ref:`int` **rendering/scaling_3d/mode.ios** :ref:`🔗` + +iOS override for :ref:`rendering/scaling_3d/mode`. This allows selecting the MetalFX spatial and MetalFX temporal scaling modes, which are exclusive to platforms where the Metal rendering driver is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/scaling_3d/mode.macos: + +.. rst-class:: classref-property + +:ref:`int` **rendering/scaling_3d/mode.macos** :ref:`🔗` + +macOS override for :ref:`rendering/scaling_3d/mode`. This allows selecting the MetalFX spatial and MetalFX temporal scaling modes, which are exclusive to platforms where the Metal rendering driver is used. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/scaling_3d/scale: .. rst-class:: classref-property diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 392018a817a..b8c3b0514dd 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -4521,6 +4521,26 @@ Maximum viewport width (in pixels). Maximum viewport height (in pixels). +.. _class_RenderingDevice_constant_LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Limit` **LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE** = ``46`` + +Returns the smallest value for :ref:`ProjectSettings.rendering/scaling_3d/scale` when using the MetalFX temporal upscaler. + +\ **Note:** The returned value is multiplied by a factor of ``1000000`` to preserve 6 digits of precision. It must be divided by ``1000000.0`` to convert the value to a floating point number. + +.. _class_RenderingDevice_constant_LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Limit` **LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE** = ``47`` + +Returns the largest value for :ref:`ProjectSettings.rendering/scaling_3d/scale` when using the MetalFX temporal upscaler. + +\ **Note:** The returned value is multiplied by a factor of ``1000000`` to preserve 6 digits of precision. It must be divided by ``1000000.0`` to convert the value to a floating point number. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 5227974d315..c9e4b67765c 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -349,7 +349,7 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_adjustment`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`environment_set_ambient_light`\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) | + | |void| | :ref:`environment_set_ambient_light`\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contribution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_background`\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2998,11 +2998,31 @@ Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. +.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL** = ``3`` + +Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. + +\ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. + +.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL** = ``4`` + +Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. + +\ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. + .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``3`` +:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``5`` Represents the size of the :ref:`ViewportScaling3DMode` enum. @@ -4220,6 +4240,14 @@ Use the Academy Color Encoding System tonemapper. ACES is slightly more expensiv \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x. +.. _class_RenderingServer_constant_ENV_TONE_MAPPER_AGX: + +.. rst-class:: classref-enumeration-constant + +:ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_AGX** = ``4`` + +Use the AgX tonemapper. AgX is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. AgX is less likely to darken parts of the scene compared to :ref:`ENV_TONE_MAPPER_ACES`, and can match :ref:`ENV_TONE_MAPPER_FILMIC` more closely. + .. rst-class:: classref-item-separator ---- @@ -7830,7 +7858,7 @@ Sets the values to be used with the "adjustments" post-process effect. See :ref: .. rst-class:: classref-method -|void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) :ref:`🔗` +|void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contribution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) :ref:`🔗` Sets the values to be used for ambient light rendering. See :ref:`Environment` for more details. diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index a909bb7f937..a3e9feeb187 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -60,11 +60,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -156,9 +156,11 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ stream_data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` -This method loads audio data from a PackedByteArray buffer into an AudioStreamOggVorbis object. +**Deprecated:** Use :ref:`AudioStreamOggVorbis.load_from_buffer` instead. + +Creates a new :ref:`AudioStreamOggVorbis` instance from the given buffer. The buffer must contain Ogg Vorbis data. .. rst-class:: classref-item-separator @@ -170,7 +172,9 @@ This method loads audio data from a PackedByteArray buffer into an AudioStreamOg :ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` -This method loads audio data from a file into an AudioStreamOggVorbis object. The file path is provided as a string. +**Deprecated:** Use :ref:`AudioStreamOggVorbis.load_from_file` instead. + +Creates a new :ref:`AudioStreamOggVorbis` instance from the given file path. The file must be in Ogg Vorbis format. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index a05eee83ea7..0cf2e2bc21d 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -155,6 +155,8 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_from`\ (\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_selection_line_offset`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to`\ (\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_total_character_count`\ (\ ) |const| | @@ -1390,6 +1392,18 @@ Returns the current selection first character index if a selection is active, `` ---- +.. _class_RichTextLabel_method_get_selection_line_offset: + +.. rst-class:: classref-method + +:ref:`float` **get_selection_line_offset**\ (\ ) |const| :ref:`🔗` + +Returns the current selection vertical line offset if a selection is active, ``-1.0`` otherwise. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_get_selection_to: .. rst-class:: classref-method diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index 38ebc225eba..df98da6d6be 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -14,7 +14,7 @@ SkeletonModifier3D **Inherited By:** :ref:`LookAtModifier3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` -A Node that may modify Skeleton3D's bone. +A node that may modify Skeleton3D's bone. .. rst-class:: classref-introduction-group @@ -87,6 +87,69 @@ Notifies when the modification have been finished. .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_SkeletonModifier3D_BoneAxis: + +.. rst-class:: classref-enumeration + +enum **BoneAxis**: :ref:`🔗` + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_PLUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_PLUS_X** = ``0`` + +Enumerated value for the +X axis. + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_MINUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_MINUS_X** = ``1`` + +Enumerated value for the -X axis. + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_PLUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_PLUS_Y** = ``2`` + +Enumerated value for the +Y axis. + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_MINUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_MINUS_Y** = ``3`` + +Enumerated value for the -Y axis. + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_PLUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_PLUS_Z** = ``4`` + +Enumerated value for the +Z axis. + +.. _class_SkeletonModifier3D_constant_BONE_AXIS_MINUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneAxis` **BONE_AXIS_MINUS_Z** = ``5`` + +Enumerated value for the -Z axis. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- diff --git a/classes/class_subtweentweener.rst b/classes/class_subtweentweener.rst new file mode 100644 index 00000000000..fb6af8f61d3 --- /dev/null +++ b/classes/class_subtweentweener.rst @@ -0,0 +1,62 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubtweenTweener.xml. + +.. _class_SubtweenTweener: + +SubtweenTweener +=============== + +**Inherits:** :ref:`Tweener` **<** :ref:`RefCounted` **<** :ref:`Object` + +Runs a :ref:`Tween` nested within another :ref:`Tween`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**SubtweenTweener** is used to execute a :ref:`Tween` as one step in a sequence defined by another :ref:`Tween`. See :ref:`Tween.tween_subtween` for more usage information. + +\ **Note:** :ref:`Tween.tween_subtween` is the only correct way to create **SubtweenTweener**. Any **SubtweenTweener** created manually will not function correctly. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------+---------------------------------------------------------------------------------------------------+ + | :ref:`SubtweenTweener` | :ref:`set_delay`\ (\ delay\: :ref:`float`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_SubtweenTweener_method_set_delay: + +.. rst-class:: classref-method + +:ref:`SubtweenTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) :ref:`🔗` + +Sets the time in seconds after which the **SubtweenTweener** will start running the subtween. By default there's no delay. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 708e96dc426..894d98c34a9 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -73,6 +73,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editable` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`emoji_menu_enabled` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty_selection_clipboard_enabled` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | @@ -858,11 +860,19 @@ Inserts word joiner (WJ) character. Inserts soft hyphen (SHY) character. +.. _class_TextEdit_constant_MENU_EMOJI_AND_SYMBOL: + +.. rst-class:: classref-enumeration-constant + +:ref:`MenuItems` **MENU_EMOJI_AND_SYMBOL** = ``30`` + +Opens system emoji and symbol picker. + .. _class_TextEdit_constant_MENU_MAX: .. rst-class:: classref-enumeration-constant -:ref:`MenuItems` **MENU_MAX** = ``30`` +:ref:`MenuItems` **MENU_MAX** = ``31`` Represents the size of the :ref:`MenuItems` enum. @@ -1363,6 +1373,23 @@ If ``false``, existing text cannot be modified and new text cannot be added. ---- +.. _class_TextEdit_property_emoji_menu_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **emoji_menu_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_emoji_menu_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emoji_menu_enabled**\ (\ ) + +If ``false``, "Emoji and Symbols" menu is enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_property_empty_selection_clipboard_enabled: .. rst-class:: classref-property diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 307aad84553..73a61ba6c32 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -337,6 +337,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) | @@ -3394,6 +3396,18 @@ Returns number of text spans added using :ref:`shaped_text_add_string` **shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns text embedded object key. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_get_span_meta: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index bfdd42d91f8..9709d621084 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -324,6 +324,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| | @@ -2524,6 +2526,20 @@ Returns number of text spans added using :ref:`_shaped_text_add_string` **_shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns text embedded object key. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__shaped_get_span_meta: .. rst-class:: classref-method diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 89ac2a7ce73..c77c7fc8f45 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -49,6 +49,8 @@ Tutorials - `2D Kinematic Character Demo `__ +- `2D Dynamic TileMap Layers Demo `__ + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst index 971da4e92e3..125e03a92de 100644 --- a/classes/class_tilemaplayer.rst +++ b/classes/class_tilemaplayer.rst @@ -25,6 +25,27 @@ For performance reasons, all TileMap updates are batched at the end of a frame. To force an update earlier on, call :ref:`update_internals`. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Using Tilemaps <../tutorials/2d/using_tilemaps>` + +- `2D Platformer Demo `__ + +- `2D Isometric Demo `__ + +- `2D Hexagonal Demo `__ + +- `2D Grid-based Navigation with AStarGrid2D Demo `__ + +- `2D Role Playing Game (RPG) Demo `__ + +- `2D Kinematic Character Demo `__ + +- `2D Dynamic TileMap Layers Demo `__ + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 97290fecc4e..e6f8c47a453 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -204,6 +204,8 @@ Methods +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PropertyTweener` | :ref:`tween_property`\ (\ object\: :ref:`Object`, property\: :ref:`NodePath`, final_val\: :ref:`Variant`, duration\: :ref:`float`\ ) | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubtweenTweener` | :ref:`tween_subtween`\ (\ subtween\: :ref:`Tween`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1049,6 +1051,35 @@ will move the sprite to position (100, 200) and then to (200, 300). If you use : +.. rst-class:: classref-item-separator + +---- + +.. _class_Tween_method_tween_subtween: + +.. rst-class:: classref-method + +:ref:`SubtweenTweener` **tween_subtween**\ (\ subtween\: :ref:`Tween`\ ) :ref:`🔗` + +Creates and appends a :ref:`SubtweenTweener`. This method can be used to nest ``subtween`` within this **Tween**, allowing for the creation of more complex and composable sequences. + +:: + + # Subtween will rotate the object. + var subtween = create_tween() + subtween.tween_property(self, "rotation_degrees", 45.0, 1.0) + subtween.tween_property(self, "rotation_degrees", 0.0, 1.0) + + # Parent tween will execute the subtween as one of its steps. + var tween = create_tween() + tween.tween_property(self, "position:x", 500, 3.0) + tween.tween_subtween(subtween) + tween.tween_property(self, "position:x", 300, 2.0) + +\ **Note:** The methods :ref:`pause`, :ref:`stop`, and :ref:`set_loops` can cause the parent **Tween** to get stuck on the subtween step; see the documentation for those methods for more information. + +\ **Note:** The pause and process modes set by :ref:`set_pause_mode` and :ref:`set_process_mode` on ``subtween`` will be overridden by the parent **Tween**'s settings. + .. |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_tweener.rst b/classes/class_tweener.rst index 5e7ae765ec4..24430c9ac13 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -12,7 +12,7 @@ Tweener **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`CallbackTweener`, :ref:`IntervalTweener`, :ref:`MethodTweener`, :ref:`PropertyTweener` +**Inherited By:** :ref:`CallbackTweener`, :ref:`IntervalTweener`, :ref:`MethodTweener`, :ref:`PropertyTweener`, :ref:`SubtweenTweener` Abstract class for all Tweeners used by :ref:`Tween`. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 162bf24f538..8924beeb334 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -378,11 +378,43 @@ Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. +.. _class_Viewport_constant_SCALING_3D_MODE_METALFX_SPATIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Scaling3DMode` **SCALING_3D_MODE_METALFX_SPATIAL** = ``3`` + +Use the `MetalFX spatial upscaler `__ for the viewport's 3D buffer. + +The amount of scaling can be set using :ref:`scaling_3d_scale`. + +Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. + +More information: `MetalFX `__. + +\ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. + +.. _class_Viewport_constant_SCALING_3D_MODE_METALFX_TEMPORAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Scaling3DMode` **SCALING_3D_MODE_METALFX_TEMPORAL** = ``4`` + +Use the `MetalFX temporal upscaler `__ for the viewport's 3D buffer. + +The amount of scaling can be set using :ref:`scaling_3d_scale`. To determine the minimum input scale, use the :ref:`RenderingDevice.limit_get` method with :ref:`RenderingDevice.LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE`. + +Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. + +More information: `MetalFX `__. + +\ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. + .. _class_Viewport_constant_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Scaling3DMode` **SCALING_3D_MODE_MAX** = ``3`` +:ref:`Scaling3DMode` **SCALING_3D_MODE_MAX** = ``5`` Represents the size of the :ref:`Scaling3DMode` enum. diff --git a/classes/class_window.rst b/classes/class_window.rst index 8f1e7c72952..4016b9f5ae4 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -256,6 +256,10 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`show`\ (\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_drag`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_resize`\ (\ edge\: :ref:`WindowResizeEdge`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -2555,6 +2559,30 @@ Enables font oversampling. This makes fonts look better when they are scaled up. Makes the **Window** appear. This enables interactions with the **Window** and doesn't change any of its property other than visibility (unlike e.g. :ref:`popup`). +.. rst-class:: classref-item-separator + +---- + +.. _class_Window_method_start_drag: + +.. rst-class:: classref-method + +|void| **start_drag**\ (\ ) :ref:`🔗` + +Starts an interactive drag operation on the window, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Window_method_start_resize: + +.. rst-class:: classref-method + +|void| **start_resize**\ (\ edge\: :ref:`WindowResizeEdge`\ ) :ref:`🔗` + +Starts an interactive resize operation on the window, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_xrvrs.rst b/classes/class_xrvrs.rst index 2bfabac8587..584668ddce4 100644 --- a/classes/class_xrvrs.rst +++ b/classes/class_xrvrs.rst @@ -29,11 +29,13 @@ Properties .. table:: :widths: auto - +---------------------------+------------------------------------------------------------+----------+ - | :ref:`float` | :ref:`vrs_min_radius` | ``20.0`` | - +---------------------------+------------------------------------------------------------+----------+ - | :ref:`float` | :ref:`vrs_strength` | ``1.0`` | - +---------------------------+------------------------------------------------------------+----------+ + +-----------------------------+------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`vrs_min_radius` | ``20.0`` | + +-----------------------------+------------------------------------------------------------------+------------------------+ + | :ref:`Rect2i` | :ref:`vrs_render_region` | ``Rect2i(0, 0, 0, 0)`` | + +-----------------------------+------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`vrs_strength` | ``1.0`` | + +-----------------------------+------------------------------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group @@ -73,6 +75,23 @@ The minimum radius around the focal point where full quality is guaranteed if VR ---- +.. _class_XRVRS_property_vrs_render_region: + +.. rst-class:: classref-property + +:ref:`Rect2i` **vrs_render_region** = ``Rect2i(0, 0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_vrs_render_region**\ (\ value\: :ref:`Rect2i`\ ) +- :ref:`Rect2i` **get_vrs_render_region**\ (\ ) + +The render region that the VRS texture will be scaled to when generated. + +.. rst-class:: classref-item-separator + +---- + .. _class_XRVRS_property_vrs_strength: .. rst-class:: classref-property diff --git a/classes/index.rst b/classes/index.rst index f1e4d31dd32..63be9c44287 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -943,6 +943,7 @@ Other objects class_streampeergzip class_streampeertcp class_streampeertls + class_subtweentweener class_surfacetool class_tcpserver class_textline