From aa75fde1b5ac5f15e3e5b52fb75220c9d713b637 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 5 Oct 2024 03:32:08 +0000 Subject: [PATCH] classref: Sync with current master branch (db66bd3) --- classes/class_@gdscript.rst | 47 ++ classes/class_@globalscope.rst | 19 +- classes/class_animation.rst | 140 +++++ classes/class_animationplayer.rst | 150 ++++++ classes/class_cameraattributesphysical.rst | 2 +- classes/class_camerafeed.rst | 56 ++ classes/class_dictionary.rst | 14 + classes/class_displayserver.rst | 16 + classes/class_editorcontextmenuplugin.rst | 24 + classes/class_editorexportplatformios.rst | 562 ++++++++++++++++++++- classes/class_editorexportplugin.rst | 16 + classes/class_editorinspector.rst | 2 + classes/class_editorinterface.rst | 14 + classes/class_editorsettings.rst | 44 +- classes/class_enetpacketpeer.rst | 14 + classes/class_filedialog.rst | 107 +++- classes/class_graphedit.rst | 12 + classes/class_inputmap.rst | 4 +- classes/class_itemlist.rst | 231 +++++---- classes/class_lineedit.rst | 32 +- classes/class_performance.rst | 42 +- classes/class_popupmenu.rst | 2 +- classes/class_popuppanel.rst | 2 +- classes/class_projectsettings.rst | 20 +- classes/class_renderingserver.rst | 100 +++- classes/class_scenemultiplayer.rst | 2 +- classes/class_signal.rst | 2 +- classes/class_sprite2d.rst | 2 +- classes/class_textserver.rst | 10 + classes/class_translationdomain.rst | 218 ++++++++ classes/class_translationserver.rst | 6 +- classes/class_treeitem.rst | 30 ++ classes/class_vector4i.rst | 2 +- classes/class_webxrinterface.rst | 2 +- 34 files changed, 1773 insertions(+), 173 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 669f9759e83..8df1a7d1d91 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -711,6 +711,53 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP`, icon\: :ref:`String` = ""\ ) :ref:`πŸ”—` + +Export a :ref:`Callable` property as a clickable button with the label ``text``. When the button is pressed, the callable is called. + +If ``icon`` is specified, it is used to fetch an icon for the button via :ref:`Control.get_theme_icon`, from the ``"EditorIcons"`` theme type. If ``icon`` is omitted, the default ``"Callable"`` icon is used instead. + +Consider using the :ref:`EditorUndoRedoManager` to allow the action to be reverted safely. + +See also :ref:`@GlobalScope.PROPERTY_HINT_TOOL_BUTTON`. + +:: + + @tool + extends Sprite2D + + @export_tool_button("Hello") var hello_action = hello + @export_tool_button("Randomize the color!", "ColorRect") + var randomize_color_action = randomize_color + + func hello(): + print("Hello world!") + + func randomize_color(): + var undo_redo = EditorInterface.get_editor_undo_redo() + undo_redo.create_action("Randomized Sprite2D Color") + undo_redo.add_do_property(self, &"self_modulate", Color(randf(), randf(), randf())) + undo_redo.add_undo_property(self, &"self_modulate", self_modulate) + undo_redo.commit_action() + +\ **Note:** The property is exported without the :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` flag because a :ref:`Callable` cannot be properly serialized and stored in a file. + +\ **Note:** In an exported project neither :ref:`EditorInterface` nor :ref:`EditorUndoRedoManager` exist, which may cause some scripts to break. To prevent this, you can use :ref:`Engine.get_singleton` and omit the static type from the variable declaration: + +:: + + var undo_redo = Engine.get_singleton(&"EditorInterface").get_editor_undo_redo() + +\ **Note:** Avoid storing lambda callables in member variables of :ref:`RefCounted`-based classes (e.g. resources), as this can lead to memory leaks. Use only method callables and optionally :ref:`Callable.bind` or :ref:`Callable.unbind`. + +.. rst-class:: classref-item-separator + +---- + .. _class_@GDScript_annotation_@icon: .. rst-class:: classref-annotation diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 2a3bd5b5ea9..1684c54105f 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3852,11 +3852,26 @@ Hints that a quaternion property should disable the temporary euler editor. Hints that a string property is a password, and every character is replaced with the secret character. +.. _class_@GlobalScope_constant_PROPERTY_HINT_TOOL_BUTTON: + +.. rst-class:: classref-enumeration-constant + +:ref:`PropertyHint` **PROPERTY_HINT_TOOL_BUTTON** = ``39`` + +Hints that a :ref:`Callable` property should be displayed as a clickable button. When the button is pressed, the callable is called. The hint string specifies the button text and optionally an icon from the ``"EditorIcons"`` theme type. + +.. code:: text + + "Click me!" - A button with the text "Click me!" and the default "Callable" icon. + "Click me!,ColorRect" - A button with the text "Click me!" and the "ColorRect" icon. + +\ **Note:** A :ref:`Callable` cannot be properly serialized and stored in a file, so it is recommended to use :ref:`PROPERTY_USAGE_EDITOR` instead of :ref:`PROPERTY_USAGE_DEFAULT`. + .. _class_@GlobalScope_constant_PROPERTY_HINT_MAX: .. rst-class:: classref-enumeration-constant -:ref:`PropertyHint` **PROPERTY_HINT_MAX** = ``39`` +:ref:`PropertyHint` **PROPERTY_HINT_MAX** = ``40`` Represents the size of the :ref:`PropertyHint` enum. @@ -7023,7 +7038,7 @@ Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` :ref:`int` **signi**\ (\ x\: :ref:`int`\ ) :ref:`πŸ”—` -Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if ``x`` is zero. +Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if ``x`` is zero. :: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 177dde545b6..94979b016c0 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -85,6 +85,8 @@ Methods .. table:: :widths: auto + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_marker`\ (\ name\: :ref:`StringName`, time\: :ref:`float`\ ) | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_track`\ (\ type\: :ref:`TrackType`, at_position\: :ref:`int` = -1\ ) | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -140,8 +142,22 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_track`\ (\ path\: :ref:`NodePath`, type\: :ref:`TrackType`\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_marker_at_time`\ (\ time\: :ref:`float`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_marker_color`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_marker_names`\ (\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_marker_time`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_next_marker`\ (\ time\: :ref:`float`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_prev_marker`\ (\ time\: :ref:`float`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_track_count`\ (\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_marker`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`method_track_get_name`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`method_track_get_params`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | @@ -152,6 +168,8 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`position_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_marker`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_track`\ (\ track_idx\: :ref:`int`\ ) | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rotation_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, rotation\: :ref:`Quaternion`\ ) | @@ -162,6 +180,8 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`scale_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_marker_color`\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_find_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false, backward\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap`\ (\ track_idx\: :ref:`int`\ ) |const| | @@ -583,6 +603,18 @@ The animation step value. Method Descriptions ------------------- +.. _class_Animation_method_add_marker: + +.. rst-class:: classref-method + +|void| **add_marker**\ (\ name\: :ref:`StringName`, time\: :ref:`float`\ ) :ref:`πŸ”—` + +Adds a marker to this Animation. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_add_track: .. rst-class:: classref-method @@ -917,6 +949,78 @@ Returns the index of the specified track. If the track is not found, return -1. ---- +.. _class_Animation_method_get_marker_at_time: + +.. rst-class:: classref-method + +:ref:`StringName` **get_marker_at_time**\ (\ time\: :ref:`float`\ ) |const| :ref:`πŸ”—` + +Returns the name of the marker located at the given time. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Animation_method_get_marker_color: + +.. rst-class:: classref-method + +:ref:`Color` **get_marker_color**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`πŸ”—` + +Returns the given marker's color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Animation_method_get_marker_names: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **get_marker_names**\ (\ ) |const| :ref:`πŸ”—` + +Returns every marker in this Animation, sorted ascending by time. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Animation_method_get_marker_time: + +.. rst-class:: classref-method + +:ref:`float` **get_marker_time**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`πŸ”—` + +Returns the given marker's time. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Animation_method_get_next_marker: + +.. rst-class:: classref-method + +:ref:`StringName` **get_next_marker**\ (\ time\: :ref:`float`\ ) |const| :ref:`πŸ”—` + +Returns the closest marker that comes after the given time. If no such marker exists, an empty string is returned. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Animation_method_get_prev_marker: + +.. rst-class:: classref-method + +:ref:`StringName` **get_prev_marker**\ (\ time\: :ref:`float`\ ) |const| :ref:`πŸ”—` + +Returns the closest marker that comes before the given time. If no such marker exists, an empty string is returned. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_get_track_count: .. rst-class:: classref-method @@ -929,6 +1033,18 @@ Returns the amount of tracks in the animation. ---- +.. _class_Animation_method_has_marker: + +.. rst-class:: classref-method + +:ref:`bool` **has_marker**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`πŸ”—` + +Returns ``true`` if this Animation contains a marker with the given name. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_method_track_get_name: .. rst-class:: classref-method @@ -989,6 +1105,18 @@ Returns the interpolated position value at the given time (in seconds). The ``tr ---- +.. _class_Animation_method_remove_marker: + +.. rst-class:: classref-method + +|void| **remove_marker**\ (\ name\: :ref:`StringName`\ ) :ref:`πŸ”—` + +Removes the marker with the given name from this Animation. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_remove_track: .. rst-class:: classref-method @@ -1049,6 +1177,18 @@ Returns the interpolated scale value at the given time (in seconds). The ``track ---- +.. _class_Animation_method_set_marker_color: + +.. rst-class:: classref-method + +|void| **set_marker_color**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) :ref:`πŸ”—` + +Sets the given marker's color. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_track_find_key: .. rst-class:: classref-method diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index b11956e6de9..c43c0d34d58 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -99,6 +99,12 @@ Methods +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_root`\ (\ ) |const| | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_section_end_time`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_section_start_time`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_section`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`pause`\ (\ ) | @@ -107,10 +113,20 @@ Methods +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_section`\ (\ name\: :ref:`StringName` = &"", start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_section_backwards`\ (\ name\: :ref:`StringName` = &"", start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1, custom_blend\: :ref:`float` = -1\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_section_with_markers`\ (\ name\: :ref:`StringName` = &"", start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_section_with_markers_backwards`\ (\ name\: :ref:`StringName` = &"", start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`play_with_capture`\ (\ name\: :ref:`StringName` = &"", duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`queue`\ (\ name\: :ref:`StringName`\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_section`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`seek`\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) | @@ -121,6 +137,10 @@ Methods +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_root`\ (\ path\: :ref:`NodePath`\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_section`\ (\ start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_section_with_markers`\ (\ start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &""\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`stop`\ (\ keep_state\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -572,6 +592,42 @@ Returns the node which node path references will travel from. ---- +.. _class_AnimationPlayer_method_get_section_end_time: + +.. rst-class:: classref-method + +:ref:`float` **get_section_end_time**\ (\ ) |const| :ref:`πŸ”—` + +Returns the end time of the section currently being played. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_get_section_start_time: + +.. rst-class:: classref-method + +:ref:`float` **get_section_start_time**\ (\ ) |const| :ref:`πŸ”—` + +Returns the start time of the section currently being played. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_has_section: + +.. rst-class:: classref-method + +:ref:`bool` **has_section**\ (\ ) |const| :ref:`πŸ”—` + +Returns ``true`` if an animation is currently playing with section. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationPlayer_method_is_playing: .. rst-class:: classref-method @@ -630,6 +686,62 @@ This method is a shorthand for :ref:`play` wi ---- +.. _class_AnimationPlayer_method_play_section: + +.. rst-class:: classref-method + +|void| **play_section**\ (\ name\: :ref:`StringName` = &"", start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) :ref:`πŸ”—` + +Plays the animation with key ``name`` and the section starting from ``start_time`` and ending on ``end_time``. See also :ref:`play`. + +Setting ``start_time`` to a value outside the range of the animation means the start of the animation will be used instead, and setting ``end_time`` to a value outside the range of the animation means the end of the animation will be used instead. ``start_time`` cannot be equal to ``end_time``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_play_section_backwards: + +.. rst-class:: classref-method + +|void| **play_section_backwards**\ (\ name\: :ref:`StringName` = &"", start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1, custom_blend\: :ref:`float` = -1\ ) :ref:`πŸ”—` + +Plays the animation with key ``name`` and the section starting from ``start_time`` and ending on ``end_time`` in reverse. + +This method is a shorthand for :ref:`play_section` with ``custom_speed = -1.0`` and ``from_end = true``, see its description for more information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_play_section_with_markers: + +.. rst-class:: classref-method + +|void| **play_section_with_markers**\ (\ name\: :ref:`StringName` = &"", start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) :ref:`πŸ”—` + +Plays the animation with key ``name`` and the section starting from ``start_marker`` and ending on ``end_marker``. + +If the start marker is empty, the section starts from the beginning of the animation. If the end marker is empty, the section ends on the end of the animation. See also :ref:`play`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_play_section_with_markers_backwards: + +.. rst-class:: classref-method + +|void| **play_section_with_markers_backwards**\ (\ name\: :ref:`StringName` = &"", start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) :ref:`πŸ”—` + +Plays the animation with key ``name`` and the section starting from ``start_marker`` and ending on ``end_marker`` in reverse. + +This method is a shorthand for :ref:`play_section_with_markers` with ``custom_speed = -1.0`` and ``from_end = true``, see its description for more information. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationPlayer_method_play_with_capture: .. rst-class:: classref-method @@ -669,6 +781,18 @@ Queues an animation for playback once the current animation and all previously q ---- +.. _class_AnimationPlayer_method_reset_section: + +.. rst-class:: classref-method + +|void| **reset_section**\ (\ ) :ref:`πŸ”—` + +Resets the current section if section is set. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationPlayer_method_seek: .. rst-class:: classref-method @@ -739,6 +863,32 @@ Sets the node which node path references will travel from. ---- +.. _class_AnimationPlayer_method_set_section: + +.. rst-class:: classref-method + +|void| **set_section**\ (\ start_time\: :ref:`float` = -1, end_time\: :ref:`float` = -1\ ) :ref:`πŸ”—` + +Changes the start and end times of the section being played. The current playback position will be clamped within the new section. See also :ref:`play_section`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_method_set_section_with_markers: + +.. rst-class:: classref-method + +|void| **set_section_with_markers**\ (\ start_marker\: :ref:`StringName` = &"", end_marker\: :ref:`StringName` = &""\ ) :ref:`πŸ”—` + +Changes the start and end markers of the section being played. The current playback position will be clamped within the new section. See also :ref:`play_section_with_markers`. + +If the argument is empty, the section uses the beginning or end of the animation. If both are empty, it means that the section is not set. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationPlayer_method_stop: .. rst-class:: classref-method diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index 1399d5f135c..89be06443f1 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -109,7 +109,7 @@ The maximum luminance (in EV100) used when calculating auto exposure. When calcu - |void| **set_auto_exposure_min_exposure_value**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_auto_exposure_min_exposure_value**\ (\ ) -The minimum luminance luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. +The minimum luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. .. rst-class:: classref-item-separator diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 919539d6467..60f32bf6f20 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -58,6 +58,14 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`set_format`\ (\ index\: :ref:`int`, parameters\: :ref:`Dictionary`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_name`\ (\ name\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_position`\ (\ position\: :ref:`FeedPosition`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_rgb_image`\ (\ rgb_image\: :ref:`Image`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ycbcr_image`\ (\ ycbcr_image\: :ref:`Image`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -295,6 +303,54 @@ Sets the feed format parameters for the given index in the :ref:`formats`\ ) :ref:`πŸ”—` + +Sets the camera's name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CameraFeed_method_set_position: + +.. rst-class:: classref-method + +|void| **set_position**\ (\ position\: :ref:`FeedPosition`\ ) :ref:`πŸ”—` + +Sets the position of this camera. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CameraFeed_method_set_rgb_image: + +.. rst-class:: classref-method + +|void| **set_rgb_image**\ (\ rgb_image\: :ref:`Image`\ ) :ref:`πŸ”—` + +Sets RGB image for this feed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CameraFeed_method_set_ycbcr_image: + +.. rst-class:: classref-method + +|void| **set_ycbcr_image**\ (\ ycbcr_image\: :ref:`Image`\ ) :ref:`πŸ”—` + +Sets YCbCr image for this feed. + .. |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_dictionary.rst b/classes/class_dictionary.rst index 250c05c28af..e79d7ae19d2 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -291,6 +291,8 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size`\ (\ ) |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`values`\ (\ ) |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -851,6 +853,18 @@ Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) al ---- +.. _class_Dictionary_method_sort: + +.. rst-class:: classref-method + +|void| **sort**\ (\ ) :ref:`πŸ”—` + +Sorts the dictionary in-place by key. This can be used to ensure dictionaries with the same contents produce equivalent results when getting the :ref:`keys`, getting the :ref:`values`, and converting to a string. This is also useful when wanting a JSON representation consistent with what is in memory, and useful for storing on a database that requires dictionaries to be sorted. + +.. rst-class:: classref-item-separator + +---- + .. _class_Dictionary_method_values: .. rst-class:: classref-method diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 18a5e165dbb..a07fb68fb15 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -194,6 +194,8 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_hardware_keyboard`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | @@ -2907,6 +2909,20 @@ Returns ``true`` if the specified ``feature`` is supported by the current **Disp ---- +.. _class_DisplayServer_method_has_hardware_keyboard: + +.. rst-class:: classref-method + +:ref:`bool` **has_hardware_keyboard**\ (\ ) |const| :ref:`πŸ”—` + +Returns ``true`` if hardware keyboard is connected. + +\ **Note:** This method is implemented on Android and iOS, on other platforms this method always returns ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_help_set_search_callbacks: .. rst-class:: classref-method diff --git a/classes/class_editorcontextmenuplugin.rst b/classes/class_editorcontextmenuplugin.rst index 40ad945dc15..d99156845a4 100644 --- a/classes/class_editorcontextmenuplugin.rst +++ b/classes/class_editorcontextmenuplugin.rst @@ -38,6 +38,8 @@ Methods +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_context_menu_item_from_shortcut`\ (\ name\: :ref:`String`, shortcut\: :ref:`Shortcut`, icon\: :ref:`Texture2D` = null\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_context_submenu_item`\ (\ name\: :ref:`String`, menu\: :ref:`PopupMenu`, icon\: :ref:`Texture2D` = null\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_menu_shortcut`\ (\ shortcut\: :ref:`Shortcut`, callback\: :ref:`Callable`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -148,6 +150,28 @@ Add custom option to the context menu of the plugin's specified slot. The option ---- +.. _class_EditorContextMenuPlugin_method_add_context_submenu_item: + +.. rst-class:: classref-method + +|void| **add_context_submenu_item**\ (\ name\: :ref:`String`, menu\: :ref:`PopupMenu`, icon\: :ref:`Texture2D` = null\ ) :ref:`πŸ”—` + +Add a submenu to the context menu of the plugin's specified slot. The submenu is not automatically handled, you need to connect to its signals yourself. Also the submenu is freed on every popup, so provide a new :ref:`PopupMenu` every time. + +:: + + func _popup_menu(paths): + var popup_menu = PopupMenu.new() + popup_menu.add_item("Blue") + popup_menu.add_item("White") + popup_menu.id_pressed.connect(_on_color_submenu_option) + + add_context_menu_item("Set Node Color", popup_menu) + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorContextMenuPlugin_method_add_menu_shortcut: .. rst-class:: classref-method diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index e8473aacae5..09ac272cd34 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -84,28 +84,106 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/app_store_1024x1024` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_76x76` | + | :ref:`String` | :ref:`icons/app_store_1024x1024_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/app_store_1024x1024_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/icon_1024x1024_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_128x128` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_128x128_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_128x128_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_136x136` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_136x136_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_136x136_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_192x192` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_192x192_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ios_192x192_tinted` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/ipad_152x152` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_152x152_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_152x152_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/ipad_167x167` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_167x167_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_167x167_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/iphone_120x120` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_120x120_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_120x120_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/iphone_180x180` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_180x180_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_180x180_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/notification_40x40` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_40x40_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_40x40_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/notification_60x60` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_60x60_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_60x60_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_76x76` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_76x76_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_76x76_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_114x114` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_114x114_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_114x114_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/settings_58x58` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_58x58_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_58x58_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/settings_87x87` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/spotlight_40x40` | + | :ref:`String` | :ref:`icons/settings_87x87_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_87x87_tinted` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`icons/spotlight_80x80` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_80x80_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_80x80_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_120x120` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_120x120_dark` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_120x120_tinted` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`privacy/active_keyboard_access_reasons` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`privacy/camera_usage_description` | @@ -761,13 +839,169 @@ App Store application icon file. If left empty, it will fallback to :ref:`Projec ---- -.. _class_EditorExportPlatformIOS_property_icons/ipad_76x76: +.. _class_EditorExportPlatformIOS_property_icons/app_store_1024x1024_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/app_store_1024x1024_dark** :ref:`πŸ”—` + +App Store application icon file, dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/app_store_1024x1024_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/app_store_1024x1024_tinted** :ref:`πŸ”—` + +App Store application icon file, tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/icon_1024x1024: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024** :ref:`πŸ”—` + +Base application icon used to generate other icons. If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/icon_1024x1024_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024_dark** :ref:`πŸ”—` + +Base application icon used to generate other icons, dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/icon_1024x1024_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/icon_1024x1024_tinted** :ref:`πŸ”—` + +Base application icon used to generate other icons, tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_128x128: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_128x128** :ref:`πŸ”—` + +iOS application 64x64 icon file (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_128x128_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_128x128_dark** :ref:`πŸ”—` + +iOS application 64x64 icon file (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_128x128_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_128x128_tinted** :ref:`πŸ”—` + +iOS application 64x64 icon file (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_136x136: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_136x136** :ref:`πŸ”—` + +iOS application 68x68 icon file (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_136x136_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_136x136_dark** :ref:`πŸ”—` + +iOS application 68x68 icon file (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_136x136_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_136x136_tinted** :ref:`πŸ”—` + +iOS application 68x68 icon file (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_192x192: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_192x192** :ref:`πŸ”—` + +iOS application 64x64 icon file (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_192x192_dark: .. rst-class:: classref-property -:ref:`String` **icons/ipad_76x76** :ref:`πŸ”—` +:ref:`String` **icons/ios_192x192_dark** :ref:`πŸ”—` -Home screen application icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. +iOS application 64x64 icon file (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ios_192x192_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/ios_192x192_tinted** :ref:`πŸ”—` + +iOS application 64x64 icon file (3x DPI), tinted version. See `App icons `__. .. rst-class:: classref-item-separator @@ -785,6 +1019,30 @@ Home screen application icon file on iPad (2x DPI). If left empty, it will fallb ---- +.. _class_EditorExportPlatformIOS_property_icons/ipad_152x152_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_152x152_dark** :ref:`πŸ”—` + +Home screen application icon file on iPad (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ipad_152x152_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_152x152_tinted** :ref:`πŸ”—` + +Home screen application icon file on iPad (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/ipad_167x167: .. rst-class:: classref-property @@ -797,6 +1055,30 @@ Home screen application icon file on iPad (3x DPI). If left empty, it will fallb ---- +.. _class_EditorExportPlatformIOS_property_icons/ipad_167x167_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_167x167_dark** :ref:`πŸ”—` + +Home screen application icon file on iPad (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ipad_167x167_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_167x167_tinted** :ref:`πŸ”—` + +Home screen application icon file on iPad (3x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/iphone_120x120: .. rst-class:: classref-property @@ -809,6 +1091,30 @@ Home screen application icon file on iPhone (2x DPI). If left empty, it will fal ---- +.. _class_EditorExportPlatformIOS_property_icons/iphone_120x120_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_120x120_dark** :ref:`πŸ”—` + +Home screen application icon file on iPhone (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/iphone_120x120_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_120x120_tinted** :ref:`πŸ”—` + +Home screen application icon file on iPhone (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/iphone_180x180: .. rst-class:: classref-property @@ -821,6 +1127,30 @@ Home screen application icon file on iPhone (3x DPI). If left empty, it will fal ---- +.. _class_EditorExportPlatformIOS_property_icons/iphone_180x180_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_180x180_dark** :ref:`πŸ”—` + +Home screen application icon file on iPhone (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/iphone_180x180_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_180x180_tinted** :ref:`πŸ”—` + +Home screen application icon file on iPhone (3x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/notification_40x40: .. rst-class:: classref-property @@ -833,6 +1163,30 @@ Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallb ---- +.. _class_EditorExportPlatformIOS_property_icons/notification_40x40_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_40x40_dark** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_40x40_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_40x40_tinted** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/notification_60x60: .. rst-class:: classref-property @@ -845,6 +1199,102 @@ Notification icon file on iPhone (3x DPI). If left empty, it will fallback to :r ---- +.. _class_EditorExportPlatformIOS_property_icons/notification_60x60_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_60x60_dark** :ref:`πŸ”—` + +Notification icon file on iPhone (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_60x60_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_60x60_tinted** :ref:`πŸ”—` + +Notification icon file on iPhone (3x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_76x76: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_76x76** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_76x76_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_76x76_dark** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_76x76_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_76x76_tinted** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_114x114: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_114x114** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_114x114_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_114x114_dark** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_114x114_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_114x114_tinted** :ref:`πŸ”—` + +Notification icon file on iPad and iPhone (3x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/settings_58x58: .. rst-class:: classref-property @@ -857,6 +1307,30 @@ Application settings icon file on iPad and iPhone (2x DPI). If left empty, it wi ---- +.. _class_EditorExportPlatformIOS_property_icons/settings_58x58_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/settings_58x58_dark** :ref:`πŸ”—` + +Application settings icon file on iPad and iPhone (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/settings_58x58_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/settings_58x58_tinted** :ref:`πŸ”—` + +Application settings icon file on iPad and iPhone (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_icons/settings_87x87: .. rst-class:: classref-property @@ -869,13 +1343,25 @@ Application settings icon file on iPhone (3x DPI). If left empty, it will fallba ---- -.. _class_EditorExportPlatformIOS_property_icons/spotlight_40x40: +.. _class_EditorExportPlatformIOS_property_icons/settings_87x87_dark: .. rst-class:: classref-property -:ref:`String` **icons/spotlight_40x40** :ref:`πŸ”—` +:ref:`String` **icons/settings_87x87_dark** :ref:`πŸ”—` -Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. +Application settings icon file on iPhone (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/settings_87x87_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/settings_87x87_tinted** :ref:`πŸ”—` + +Application settings icon file on iPhone (3x DPI), tinted version. See `App icons `__. .. rst-class:: classref-item-separator @@ -893,6 +1379,66 @@ Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback ---- +.. _class_EditorExportPlatformIOS_property_icons/spotlight_80x80_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_80x80_dark** :ref:`πŸ”—` + +Spotlight icon file on iPad and iPhone (2x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_80x80_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_80x80_tinted** :ref:`πŸ”—` + +Spotlight icon file on iPad and iPhone (2x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_120x120: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_120x120** :ref:`πŸ”—` + +Spotlight icon file on iPad and iPhone (3x DPI). If left empty, it will fallback to :ref:`ProjectSettings.application/config/icon`. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_120x120_dark: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_120x120_dark** :ref:`πŸ”—` + +Spotlight icon file on iPad and iPhone (3x DPI), dark version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_120x120_tinted: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_120x120_tinted** :ref:`πŸ”—` + +Spotlight icon file on iPad and iPhone (3x DPI), tinted version. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_privacy/active_keyboard_access_reasons: .. rst-class:: classref-property diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index d8b95ad88d2..beb15d4a2c3 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -73,6 +73,8 @@ Methods +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_export_features`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_get_export_option_visibility`\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_export_option_warning`\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_export_options`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | @@ -361,6 +363,20 @@ Return a :ref:`PackedStringArray` of additional feature ---- +.. _class_EditorExportPlugin_private_method__get_export_option_visibility: + +.. rst-class:: classref-method + +:ref:`bool` **_get_export_option_visibility**\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| :ref:`πŸ”—` + +**Optional.**\ + +Validates ``option`` and returns the visibility for the specified ``platform``. The default implementation returns ``true`` for all options. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_private_method__get_export_option_warning: .. rst-class:: classref-method diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 66c9121f130..a3d9f0fbe17 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -39,6 +39,8 @@ Properties .. table:: :widths: auto + +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | follow_focus | ``true`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ScrollMode` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 4de5e6f98e6..9f57b172f9a 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -144,6 +144,8 @@ Methods +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`popup_property_selector`\ (\ object\: :ref:`Object`, callback\: :ref:`Callable`, type_filter\: :ref:`PackedInt32Array` = PackedInt32Array(), current_value\: :ref:`String` = ""\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_quick_open`\ (\ callback\: :ref:`Callable`, base_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reload_scene_from_path`\ (\ scene_filepath\: :ref:`String`\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`restart_editor`\ (\ save\: :ref:`bool` = true\ ) | @@ -779,6 +781,18 @@ Pops up an editor dialog for selecting properties from ``object``. The ``callbac ---- +.. _class_EditorInterface_method_popup_quick_open: + +.. rst-class:: classref-method + +|void| **popup_quick_open**\ (\ callback\: :ref:`Callable`, base_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`πŸ”—` + +Pops up an editor dialog for quick selecting a resource file. The ``callback`` must take a single argument of type :ref:`String` which will contain the path of the selected resource or be empty if the dialog is canceled. If ``base_types`` is provided, the dialog will only show resources that match these types. Only types deriving from :ref:`Resource` are supported. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_reload_scene_from_path: .. rst-class:: classref-method diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 83c3d2592cc..7d2bf6e55c7 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -391,6 +391,10 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/quick_open_dialog/default_display_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/quick_open_dialog/include_addons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input/buffering/agile_event_flushing` | @@ -451,8 +455,6 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/project_manager_screen` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/remember_window_size_and_position` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/save_on_focus_loss` | @@ -3001,6 +3003,30 @@ If ``true``, when saving a file, the editor will rename the old file to a differ ---- +.. _class_EditorSettings_property_filesystem/quick_open_dialog/default_display_mode: + +.. rst-class:: classref-property + +:ref:`int` **filesystem/quick_open_dialog/default_display_mode** :ref:`πŸ”—` + +If set to ``Adaptive``, the dialog opens in list view or grid view depending on the requested type. If set to ``Last Used``, the display mode will always open the way you last used it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_filesystem/quick_open_dialog/include_addons: + +.. rst-class:: classref-property + +:ref:`bool` **filesystem/quick_open_dialog/include_addons** :ref:`πŸ”—` + +If ``true``, results will include files located in the ``addons`` folder. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_filesystem/tools/oidn/oidn_denoise_path: .. rst-class:: classref-property @@ -3205,7 +3231,7 @@ Translations are provided by the community. If you spot a mistake, :doc:`contrib :ref:`int` **interface/editor/editor_screen** :ref:`πŸ”—` -The preferred monitor to display the editor. +The preferred monitor to display the editor. If **Auto**, the editor will remember the last screen it was displayed on across restarts. .. rst-class:: classref-item-separator @@ -3405,18 +3431,6 @@ The preferred monitor to display the project manager. ---- -.. _class_EditorSettings_property_interface/editor/remember_window_size_and_position: - -.. rst-class:: classref-property - -:ref:`bool` **interface/editor/remember_window_size_and_position** :ref:`πŸ”—` - -If ``true``, the editor window will remember its size, position, and which screen it was displayed on across restarts. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorSettings_property_interface/editor/save_each_scene_on_quit: .. rst-class:: classref-property diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index c0d0a0d3a63..1392cb7b3eb 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -43,6 +43,8 @@ Methods +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_channels`\ (\ ) |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_packet_flags`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_remote_address`\ (\ ) |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_remote_port`\ (\ ) |const| | @@ -359,6 +361,18 @@ Returns the number of channels allocated for communication with peer. ---- +.. _class_ENetPacketPeer_method_get_packet_flags: + +.. rst-class:: classref-method + +:ref:`int` **get_packet_flags**\ (\ ) |const| :ref:`πŸ”—` + +Returns the ENet flags of the next packet in the received queue. See ``FLAG_*`` constants for available packet flags. Note that not all flags are replicated from the sending peer to the receiving peer. + +.. rst-class:: classref-item-separator + +---- + .. _class_ENetPacketPeer_method_get_remote_address: .. rst-class:: classref-method diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index e12bc55fa96..4ba9e0555a8 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -42,6 +42,8 @@ Properties +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`FileMode` | :ref:`file_mode` | ``4`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filename_filter` | ``""`` | + +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | @@ -72,6 +74,8 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_filename_filter`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_filters`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`deselect_all`\ (\ ) | @@ -105,29 +109,31 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Color` | :ref:`file_disabled_color` | ``Color(1, 1, 1, 0.25)`` | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Color` | :ref:`file_icon_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Color` | :ref:`folder_icon_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`back_folder` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`create_folder` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`file` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`folder` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`forward_folder` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`parent_folder` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`reload` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ - | :ref:`Texture2D` | :ref:`toggle_hidden` | | - +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Color` | :ref:`file_disabled_color` | ``Color(1, 1, 1, 0.25)`` | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Color` | :ref:`file_icon_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Color` | :ref:`folder_icon_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`back_folder` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`create_folder` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`file` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`folder` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`forward_folder` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`parent_folder` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`reload` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`toggle_filename_filter` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`Texture2D` | :ref:`toggle_hidden` | | + +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-section-separator @@ -162,6 +168,18 @@ Emitted when the user selects a file by double-clicking it or pressing the **OK* ---- +.. _class_FileDialog_signal_filename_filter_changed: + +.. rst-class:: classref-signal + +**filename_filter_changed**\ (\ filter\: :ref:`String`\ ) :ref:`πŸ”—` + +Emitted when the filter for file names changes. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_signal_files_selected: .. rst-class:: classref-signal @@ -357,6 +375,25 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:` ---- +.. _class_FileDialog_property_filename_filter: + +.. rst-class:: classref-property + +:ref:`String` **filename_filter** = ``""`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_filename_filter**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_filename_filter**\ (\ ) + +The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. :ref:`filename_filter` can be edited by the user with the filter button at the top of the file dialog. + +See also :ref:`filters`, which should be used to restrict the file types that can be selected instead of :ref:`filename_filter` which is meant to be set by the user. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_property_filters: .. rst-class:: classref-property @@ -506,6 +543,18 @@ Adds an additional :ref:`OptionButton` to the file dialog. I ---- +.. _class_FileDialog_method_clear_filename_filter: + +.. rst-class:: classref-method + +|void| **clear_filename_filter**\ (\ ) :ref:`πŸ”—` + +Clear the filter for file names. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_method_clear_filters: .. rst-class:: classref-method @@ -783,6 +832,18 @@ Custom icon for the reload button. ---- +.. _class_FileDialog_theme_icon_toggle_filename_filter: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **toggle_filename_filter** :ref:`πŸ”—` + +Custom icon for the toggle button for the filter for file names. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_theme_icon_toggle_hidden: .. rst-class:: classref-themeproperty diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 9baee6bee1c..884226e695f 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -296,6 +296,18 @@ Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` b ---- +.. _class_GraphEdit_signal_cut_nodes_request: + +.. rst-class:: classref-signal + +**cut_nodes_request**\ (\ ) :ref:`πŸ”—` + +Emitted when this **GraphEdit** captures a ``ui_cut`` action (:kbd:`Ctrl + X` by default). In general, this signal indicates that the selected :ref:`GraphElement`\ s should be cut. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_signal_delete_nodes_request: .. rst-class:: classref-signal diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index e28b63284fb..406fc00140d 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -51,7 +51,7 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`action_set_deadzone`\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_action`\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) | + | |void| | :ref:`add_action`\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.2\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase_action`\ (\ action\: :ref:`StringName`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -163,7 +163,7 @@ Sets a deadzone value for the action. .. rst-class:: classref-method -|void| **add_action**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) :ref:`πŸ”—` +|void| **add_action**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.2\ ) :ref:`πŸ”—` Adds an empty action to the **InputMap** with a configurable ``deadzone``. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 06065645d89..0a8477db865 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -46,6 +46,8 @@ Properties +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`auto_height` | ``false`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`auto_width` | ``false`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`int` | :ref:`fixed_column_width` | ``0`` | @@ -79,97 +81,101 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_icon_item`\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_item`\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ idx\: :ref:`int`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect_all`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`ensure_current_is_visible`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`force_update_list_size`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_at_position`\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_custom_bg_color`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_custom_fg_color`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_icon_region`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_rect`\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_selected_items`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_anything_selected`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_icon_transposed`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_selectable`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_tooltip_enabled`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selected`\ (\ idx\: :ref:`int`\ ) |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_item`\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_custom_bg_color`\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_custom_fg_color`\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_modulate`\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_region`\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_transposed`\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_language`\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_selectable`\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text_direction`\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip_enabled`\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort_items_by_text`\ (\ ) | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_icon_item`\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_item`\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect_all`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ensure_current_is_visible`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_list_size`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_custom_bg_color`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_custom_fg_color`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_icon_region`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_rect`\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_selected_items`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_anything_selected`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_icon_transposed`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_selectable`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_tooltip_enabled`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selected`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_item`\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_auto_translate_mode`\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_custom_bg_color`\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_custom_fg_color`\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_modulate`\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_region`\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_transposed`\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_language`\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_selectable`\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text_direction`\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip_enabled`\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort_items_by_text`\ (\ ) | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -424,6 +430,23 @@ If ``true``, the control will automatically resize the height to fit its content ---- +.. _class_ItemList_property_auto_width: + +.. rst-class:: classref-property + +:ref:`bool` **auto_width** = ``false`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_width**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_auto_width**\ (\ ) + +If ``true``, the control will automatically resize the width to fit its content. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_property_fixed_column_width: .. rst-class:: classref-property @@ -715,6 +738,18 @@ When there is no item at that point, -1 will be returned if ``exact`` is ``true` ---- +.. _class_ItemList_method_get_item_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_item_auto_translate_mode**\ (\ idx\: :ref:`int`\ ) |const| :ref:`πŸ”—` + +Returns item's auto translate mode. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_method_get_item_custom_bg_color: .. rst-class:: classref-method @@ -985,6 +1020,20 @@ Select the item at the specified index. ---- +.. _class_ItemList_method_set_item_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_item_auto_translate_mode**\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`πŸ”—` + +Sets the auto translate mode of the item associated with the specified index. + +Items use :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT` by default, which uses the same auto translate mode as the **ItemList** itself. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_method_set_item_custom_bg_color: .. rst-class:: classref-method diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1f5fc59483c..04d45d011c6 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -30,7 +30,7 @@ Description - To exit edit mode, press ``ui_text_submit`` or ``ui_cancel`` (by default :kbd:`Escape`) actions. -- Check :ref:`is_editing` and :ref:`editing_toggled` for more information. +- Check :ref:`edit`, :ref:`unedit`, :ref:`is_editing`, and :ref:`editing_toggled` for more information. \ **Important:**\ @@ -175,6 +175,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`deselect`\ (\ ) | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`edit`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_scroll_offset`\ (\ ) |const| | @@ -205,6 +207,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`select_all`\ (\ ) | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unedit`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -1277,6 +1281,20 @@ Clears the current selection. ---- +.. _class_LineEdit_method_edit: + +.. rst-class:: classref-method + +|void| **edit**\ (\ ) :ref:`πŸ”—` + +Allows entering edit mode whether the **LineEdit** is focused or not. + +Use :ref:`Callable.call_deferred` if you want to enter edit mode on :ref:`text_submitted`. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_get_menu: .. rst-class:: classref-method @@ -1519,6 +1537,18 @@ Selects characters inside **LineEdit** between ``from`` and ``to``. By default, Selects the whole :ref:`String`. +.. rst-class:: classref-item-separator + +---- + +.. _class_LineEdit_method_unedit: + +.. rst-class:: classref-method + +|void| **unedit**\ (\ ) :ref:`πŸ”—` + +Allows exiting edit mode while preserving focus. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_performance.rst b/classes/class_performance.rst index f66d110dc04..6bf532036b7 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -340,11 +340,51 @@ Number of navigation mesh polygon edges that could not be merged in the :ref:`Na Number of active navigation obstacles in the :ref:`NavigationServer3D`. +.. _class_Performance_constant_PIPELINE_COMPILATIONS_CANVAS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **PIPELINE_COMPILATIONS_CANVAS** = ``34`` + +Number of pipeline compilations that were triggered by the 2D canvas renderer. + +.. _class_Performance_constant_PIPELINE_COMPILATIONS_MESH: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **PIPELINE_COMPILATIONS_MESH** = ``35`` + +Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required. + +.. _class_Performance_constant_PIPELINE_COMPILATIONS_SURFACE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **PIPELINE_COMPILATIONS_SURFACE** = ``36`` + +Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading an scene the first time a user runs the game and the pipeline is required. + +.. _class_Performance_constant_PIPELINE_COMPILATIONS_DRAW: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **PIPELINE_COMPILATIONS_DRAW** = ``37`` + +Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required. + +.. _class_Performance_constant_PIPELINE_COMPILATIONS_SPECIALIZATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **PIPELINE_COMPILATIONS_SPECIALIZATION** = ``38`` + +Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever. + .. _class_Performance_constant_MONITOR_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Monitor` **MONITOR_MAX** = ``34`` +:ref:`Monitor` **MONITOR_MAX** = ``39`` Represents the size of the :ref:`Monitor` enum. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index d58bc3a5406..d6536eb814b 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -1835,7 +1835,7 @@ Font size of the menu items. :ref:`StyleBox` **panel** :ref:`πŸ”—` -:ref:`StyleBox` for the the background panel. +:ref:`StyleBox` for the background panel. .. rst-class:: classref-item-separator diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index c72c9c55a66..b58dcc0bb73 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -48,7 +48,7 @@ Theme Property Descriptions :ref:`StyleBox` **panel** :ref:`πŸ”—` -:ref:`StyleBox` for the the background panel. +:ref:`StyleBox` for the background panel. .. |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_projectsettings.rst b/classes/class_projectsettings.rst index 048fb917ef1..61386b707ca 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1583,8 +1583,6 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading.mobile` | ``true`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_filter` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_repeat` | ``0`` | @@ -5990,7 +5988,7 @@ macOS specific override for the shortcut to select the word currently under the :ref:`Dictionary` **input/ui_text_skip_selection_for_next_occurrence** :ref:`πŸ”—` -If no selection is currently active with the last caret in text fields, searches for the next occurrence of the the word currently under the caret and moves the caret to the next occurrence. The action can be performed sequentially for other occurrences of the word under the last caret. +If no selection is currently active with the last caret in text fields, searches for the next occurrence of the word currently under the caret and moves the caret to the next occurrence. The action can be performed sequentially for other occurrences of the word under the last caret. If a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret, selects the next occurrence then deselects the previous selection and its associated caret. The action can be performed sequentially for other occurrences of the selection of the last caret. @@ -11648,22 +11646,6 @@ Lower-end override for :ref:`rendering/shading/overrides/force_lambert_over_burl If ``true``, forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. -\ **Note:** This setting currently has no effect, as vertex shading is not implemented yet. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_rendering/shading/overrides/force_vertex_shading.mobile: - -.. rst-class:: classref-property - -:ref:`bool` **rendering/shading/overrides/force_vertex_shading.mobile** = ``true`` :ref:`πŸ”—` - -Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading` on mobile devices, due to performance concerns or driver support. - -\ **Note:** This setting currently has no effect, as vertex shading is not implemented yet. - .. rst-class:: classref-item-separator ---- diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 57d55d964d6..b5473b3b97a 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -5656,6 +5656,104 @@ Buffer memory used (in bytes). This includes vertex data, uniform buffers, and m Video memory used (in bytes). When using the Forward+ or mobile rendering backends, this is always greater than the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED` and :ref:`RENDERING_INFO_BUFFER_MEM_USED`, since there is miscellaneous data not accounted for by those two metrics. When using the GL Compatibility backend, this is equal to the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED` and :ref:`RENDERING_INFO_BUFFER_MEM_USED`. +.. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS** = ``6`` + +Number of pipeline compilations that were triggered by the 2D canvas renderer. + +.. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_MESH: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_MESH** = ``7`` + +Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required. + +.. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE** = ``8`` + +Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading an scene the first time a user runs the game and the pipeline is required. + +.. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW** = ``9`` + +Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required. + +.. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION** = ``10`` + +Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_RenderingServer_PipelineSource: + +.. rst-class:: classref-enumeration + +enum **PipelineSource**: :ref:`πŸ”—` + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_CANVAS: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_CANVAS** = ``0`` + +Pipeline compilation that was triggered by the 2D canvas renderer. + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_MESH: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_MESH** = ``1`` + +Pipeline compilation that was triggered by loading a mesh. + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_SURFACE: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_SURFACE** = ``2`` + +Pipeline compilation that was triggered by building the surface cache before rendering the scene. + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_DRAW: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_DRAW** = ``3`` + +Pipeline compilation that was triggered while drawing the scene. + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_SPECIALIZATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_SPECIALIZATION** = ``4`` + +Pipeline compilation that was triggered to optimize the current scene. + +.. _class_RenderingServer_constant_PIPELINE_SOURCE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`PipelineSource` **PIPELINE_SOURCE_MAX** = ``5`` + +Represents the size of the :ref:`PipelineSource` enum. + .. rst-class:: classref-item-separator ---- @@ -7120,7 +7218,7 @@ Sets the Z range of objects that will be affected by this light. Equivalent to : Transforms both the current and previous stored transform for a canvas light. -This allows transforming a light without creating a "glitch" in the interpolation, which is is particularly useful for large worlds utilizing a shifting origin. +This allows transforming a light without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin. .. rst-class:: classref-item-separator diff --git a/classes/class_scenemultiplayer.rst b/classes/class_scenemultiplayer.rst index c5045087fe0..683287f4d44 100644 --- a/classes/class_scenemultiplayer.rst +++ b/classes/class_scenemultiplayer.rst @@ -157,7 +157,7 @@ If ``true``, the MultiplayerAPI will allow encoding and decoding of object durin - |void| **set_auth_callback**\ (\ value\: :ref:`Callable`\ ) - :ref:`Callable` **get_auth_callback**\ (\ ) -The callback to execute when when receiving authentication data sent via :ref:`send_auth`. If the :ref:`Callable` is empty (default), peers will be automatically accepted as soon as they connect. +The callback to execute when receiving authentication data sent via :ref:`send_auth`. If the :ref:`Callable` is empty (default), peers will be automatically accepted as soon as they connect. .. rst-class:: classref-item-separator diff --git a/classes/class_signal.rst b/classes/class_signal.rst index ddee6825e54..d6d55d46bd2 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -17,7 +17,7 @@ A built-in type representing a signal of an :ref:`Object`. Description ----------- -**Signal** is a built-in :ref:`Variant` type that represents a signal of an :ref:`Object` instance. Like all :ref:`Variant` types, it can be stored in variables and passed to functions. Signals allow all connected :ref:`Callable`\ s (and by extension their respective objects) to listen and react to events, without directly referencing one another. This keeps the code flexible and easier to manage. +**Signal** is a built-in :ref:`Variant` type that represents a signal of an :ref:`Object` instance. Like all :ref:`Variant` types, it can be stored in variables and passed to functions. Signals allow all connected :ref:`Callable`\ s (and by extension their respective objects) to listen and react to events, without directly referencing one another. This keeps the code flexible and easier to manage. You can check whether an :ref:`Object` has a given signal name using :ref:`Object.has_signal`. In GDScript, signals can be declared with the ``signal`` keyword. In C#, you may use the ``[Signal]`` attribute on a delegate. diff --git a/classes/class_sprite2d.rst b/classes/class_sprite2d.rst index 4acb0f4a924..dce848200f5 100644 --- a/classes/class_sprite2d.rst +++ b/classes/class_sprite2d.rst @@ -263,7 +263,7 @@ If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`\ ) - :ref:`bool` **is_region_filter_clip_enabled**\ (\ ) -If ``true``, the outermost pixels get blurred out. :ref:`region_enabled` must be ``true``. +If ``true``, the area outside of the :ref:`region_rect` is clipped to avoid bleeding of the surrounding texture pixels. :ref:`region_enabled` must be ``true``. .. rst-class:: classref-item-separator diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index edc7de09559..12d9ea2749a 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -1896,6 +1896,16 @@ Returns outline contours of the glyph as a :ref:`Dictionary` w \ ``orientation`` - :ref:`bool`, contour orientation. If ``true``, clockwise contours must be filled. +- Two successive :ref:`CONTOUR_CURVE_TAG_ON` points indicate a line segment. + +- One :ref:`CONTOUR_CURVE_TAG_OFF_CONIC` point between two :ref:`CONTOUR_CURVE_TAG_ON` points indicates a single conic (quadratic) BΓ©zier arc. + +- Two :ref:`CONTOUR_CURVE_TAG_OFF_CUBIC` points between two :ref:`CONTOUR_CURVE_TAG_ON` points indicate a single cubic BΓ©zier arc. + +- Two successive :ref:`CONTOUR_CURVE_TAG_OFF_CONIC` points indicate two successive conic (quadratic) BΓ©zier arcs with a virtual :ref:`CONTOUR_CURVE_TAG_ON` point at their middle. + +- Each contour is closed. The last point of a contour uses the first point of a contour as its next point, and vice versa. The first point can be :ref:`CONTOUR_CURVE_TAG_OFF_CONIC` point. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_translationdomain.rst b/classes/class_translationdomain.rst index 10cfaa5b6d7..9f52c1a1ec3 100644 --- a/classes/class_translationdomain.rst +++ b/classes/class_translationdomain.rst @@ -25,6 +25,34 @@ If you're working with the main translation domain, it is more convenient to use .. rst-class:: classref-reftable-group +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_accents_enabled` | ``true`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_double_vowels_enabled` | ``false`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_enabled` | ``false`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`pseudolocalization_expansion_ratio` | ``0.0`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_fake_bidi_enabled` | ``false`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_override_enabled` | ``false`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`pseudolocalization_prefix` | ``"["`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`pseudolocalization_skip_placeholders_enabled` | ``true`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`pseudolocalization_suffix` | ``"]"`` | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + Methods ------- @@ -38,6 +66,8 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | @@ -51,6 +81,182 @@ Methods .. rst-class:: classref-descriptions-group +Property Descriptions +--------------------- + +.. _class_TranslationDomain_property_pseudolocalization_accents_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_accents_enabled** = ``true`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_accents_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_accents_enabled**\ (\ ) + +Replace all characters with their accented variants during pseudolocalization. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_double_vowels_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_double_vowels_enabled** = ``false`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_double_vowels_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_double_vowels_enabled**\ (\ ) + +Double vowels in strings during pseudolocalization to simulate the lengthening of text due to localization. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_enabled** = ``false`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_enabled**\ (\ ) + +If ``true``, enables pseudolocalization for the project. This can be used to spot untranslatable strings or layout issues that may occur once the project is localized to languages that have longer strings than the source language. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_expansion_ratio: + +.. rst-class:: classref-property + +:ref:`float` **pseudolocalization_expansion_ratio** = ``0.0`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_expansion_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pseudolocalization_expansion_ratio**\ (\ ) + +The expansion ratio to use during pseudolocalization. A value of ``0.3`` is sufficient for most practical purposes, and will increase the length of each string by 30%. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_fake_bidi_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_fake_bidi_enabled** = ``false`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_fake_bidi_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_fake_bidi_enabled**\ (\ ) + +If ``true``, emulate bidirectional (right-to-left) text when pseudolocalization is enabled. This can be used to spot issues with RTL layout and UI mirroring that will crop up if the project is localized to RTL languages such as Arabic or Hebrew. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_override_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_override_enabled** = ``false`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_override_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_override_enabled**\ (\ ) + +Replace all characters in the string with ``*``. Useful for finding non-localizable strings. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_prefix: + +.. rst-class:: classref-property + +:ref:`String` **pseudolocalization_prefix** = ``"["`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_prefix**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_pseudolocalization_prefix**\ (\ ) + +Prefix that will be prepended to the pseudolocalized string. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_skip_placeholders_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **pseudolocalization_skip_placeholders_enabled** = ``true`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_skip_placeholders_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_skip_placeholders_enabled**\ (\ ) + +Skip placeholders for string formatting like ``%s`` or ``%f`` during pseudolocalization. Useful to identify strings which need additional control characters to display correctly. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TranslationDomain_property_pseudolocalization_suffix: + +.. rst-class:: classref-property + +:ref:`String` **pseudolocalization_suffix** = ``"]"`` :ref:`πŸ”—` + +.. rst-class:: classref-property-setget + +- |void| **set_pseudolocalization_suffix**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_pseudolocalization_suffix**\ (\ ) + +Suffix that will be appended to the pseudolocalized string. + +\ **Note:** Updating this property does not automatically update texts in the scene tree. Please propagate the :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` notification manually after you have finished modifying pseudolocalization related options. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Method Descriptions ------------------- @@ -90,6 +296,18 @@ Returns the :ref:`Translation` instance that best matches ``l ---- +.. _class_TranslationDomain_method_pseudolocalize: + +.. rst-class:: classref-method + +:ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| :ref:`πŸ”—` + +Returns the pseudolocalized string based on the ``message`` passed in. + +.. rst-class:: classref-item-separator + +---- + .. _class_TranslationDomain_method_remove_translation: .. rst-class:: classref-method diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index c49d161f8d5..2c2a3e67eba 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -122,7 +122,7 @@ Property Descriptions - |void| **set_pseudolocalization_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_enabled**\ (\ ) -If ``true``, enables the use of pseudolocalization. See :ref:`ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization` for details. +If ``true``, enables the use of pseudolocalization on the main translation domain. See :ref:`ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization` for details. .. rst-class:: classref-section-separator @@ -337,6 +337,8 @@ Returns ``true`` if a translation domain with the specified name exists. Returns the pseudolocalized string based on the ``message`` passed in. +\ **Note:** This method always uses the main translation domain. + .. rst-class:: classref-item-separator ---- @@ -347,7 +349,7 @@ Returns the pseudolocalized string based on the ``message`` passed in. |void| **reload_pseudolocalization**\ (\ ) :ref:`πŸ”—` -Reparses the pseudolocalization options and reloads the translation. +Reparses the pseudolocalization options and reloads the translation for the main translation domain. .. rst-class:: classref-item-separator diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 1f6e7049ea8..6cbcd7e3f31 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -68,6 +68,8 @@ Methods +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | @@ -186,6 +188,8 @@ Methods +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | @@ -504,6 +508,18 @@ Removes the button at index ``button_index`` in column ``column``. ---- +.. _class_TreeItem_method_get_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_auto_translate_mode**\ (\ column\: :ref:`int`\ ) |const| :ref:`πŸ”—` + +Returns the column's auto translate mode. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_get_autowrap_mode: .. rst-class:: classref-method @@ -1230,6 +1246,20 @@ Selects the given ``column``. ---- +.. _class_TreeItem_method_set_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_auto_translate_mode**\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`πŸ”—` + +Sets the given column's auto translate mode to ``mode``. + +All columns use :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT` by default, which uses the same auto translate mode as the :ref:`Tree` itself. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_autowrap_mode: .. rst-class:: classref-method diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 87bb06bdca1..e84af60a362 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -566,7 +566,7 @@ Gets the remainder of each component of the **Vector4i** with the components of :ref:`Vector4i` **operator %**\ (\ right\: :ref:`int`\ ) :ref:`πŸ”—` -Gets the remainder of each component of the **Vector4i** with the the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. +Gets the remainder of each component of the **Vector4i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. :: diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index de4deb8f978..a2526124c2c 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -376,7 +376,7 @@ enum **TargetRayMode**: :ref:`πŸ”—` :ref:`TargetRayMode` **TARGET_RAY_MODE_UNKNOWN** = ``0`` -We don't know the the target ray mode. +We don't know the target ray mode. .. _class_WebXRInterface_constant_TARGET_RAY_MODE_GAZE: