From 1c1e1c11bb644fd817f02eb9fdd2370bfdf90bbe Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 1 Feb 2025 03:21:10 +0000 Subject: [PATCH] classref: Sync with current master branch (1586c56) --- classes/class_cpuparticles2d.rst | 4 +- classes/class_cpuparticles3d.rst | 4 +- classes/class_displayserver.rst | 8 +++ classes/class_editorexportplatformandroid.rst | 34 ++++++------ classes/class_editorinspector.rst | 2 - classes/class_editorsettings.rst | 6 ++- classes/class_editorspinslider.rst | 53 +++++++++++++------ classes/class_filedialog.rst | 2 + classes/class_input.rst | 8 +++ classes/class_lineedit.rst | 2 +- classes/class_projectsettings.rst | 2 + classes/class_subviewport.rst | 2 + classes/class_textedit.rst | 2 +- 13 files changed, 87 insertions(+), 42 deletions(-) diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 57f60066a..35b5e4a18 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -738,7 +738,7 @@ Each particle's initial color. If :ref:`texture`\ ) - :ref:`Gradient` **get_color_initial_ramp**\ (\ ) -Each particle's initial color will vary along this :ref:`GradientTexture1D` (multiplied with :ref:`color`). +Each particle's initial color will vary along this :ref:`Gradient` (multiplied with :ref:`color`). .. rst-class:: classref-item-separator @@ -755,7 +755,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D`\ ) - :ref:`Gradient` **get_color_ramp**\ (\ ) -Each particle's color will vary along this :ref:`Gradient` (multiplied with :ref:`color`). +Each particle's color will vary along this :ref:`Gradient` over its lifetime (multiplied with :ref:`color`). .. rst-class:: classref-item-separator diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index a7d9c355a..d3f0b1bd6 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -774,7 +774,7 @@ Each particle's initial color. - |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient`\ ) - :ref:`Gradient` **get_color_initial_ramp**\ (\ ) -Each particle's initial color will vary along this :ref:`GradientTexture1D` (multiplied with :ref:`color`). +Each particle's initial color will vary along this :ref:`Gradient` (multiplied with :ref:`color`). \ **Note:** :ref:`color_initial_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp` will have no visible effect. @@ -793,7 +793,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D`\ ) - :ref:`Gradient` **get_color_ramp**\ (\ ) -Each particle's color will vary along this :ref:`GradientTexture1D` over its lifetime (multiplied with :ref:`color`). +Each particle's color will vary along this :ref:`Gradient` over its lifetime (multiplied with :ref:`color`). \ **Note:** :ref:`color_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp` will have no visible effect. diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index f8f55eccf..afa313155 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -730,6 +730,14 @@ Confines the mouse cursor to the game window, and make it visible. Confines the mouse cursor to the game window, and make it hidden. +.. _class_DisplayServer_constant_MOUSE_MODE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseMode` **MOUSE_MODE_MAX** = ``5`` + +Max value of the :ref:`MouseMode`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 7c1c00aed..c57a4611d 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -54,6 +54,8 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_template/release` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gesture/swipe_to_dismiss` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`gradle_build/android_source_template` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gradle_build/compress_native_libraries` | @@ -430,8 +432,6 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`version/name` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`wear_os/swipe_to_dismiss` | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr_features/xr_mode` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -570,6 +570,22 @@ Path to an APK file to use as a custom export template for release exports. If l ---- +.. _class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss: + +.. rst-class:: classref-property + +:ref:`bool` **gesture/swipe_to_dismiss** :ref:`🔗` + +If ``true``, `Swipe to dismiss `__ will be enabled. + +This functionality is intended for smartwatches and is generally ignored on standard Android devices. However, some devices may not ignore it. Therefore, it is recommended to keep this feature disabled for standard Android apps to avoid unexpected behavior. + +\ **Note:** This is ``false`` by default. To enable this behavior, :ref:`gradle_build/use_gradle_build` is required. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_gradle_build/android_source_template: .. rst-class:: classref-property @@ -2862,20 +2878,6 @@ Application version visible to the user. Falls back to :ref:`ProjectSettings.app ---- -.. _class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss: - -.. rst-class:: classref-property - -:ref:`bool` **wear_os/swipe_to_dismiss** :ref:`🔗` - -If ``true``, `Swipe to dismiss `__ will be enabled on Wear OS. - -\ **Note:** This is ``true`` by default. To disable this behavior, :ref:`gradle_build/use_gradle_build` is required. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorExportPlatformAndroid_property_xr_features/xr_mode: .. rst-class:: classref-property diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index c034f8f27..3adfee7b2 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -44,8 +44,6 @@ Properties +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | follow_focus | ``true`` (overrides :ref:`ScrollContainer`) | - +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ScrollMode` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index f5bb93db9..2211ef77c 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -3661,6 +3661,8 @@ This is equivalent to :ref:`ProjectSettings.display/window/subwindows/embed_subw \ **Note:** To query whether the editor can use multiple windows in an editor plugin, use :ref:`EditorInterface.is_multi_window_enabled` instead of querying the value of this editor setting. +\ **Note:** If ``true``, game embedding is disabled. + .. rst-class:: classref-item-separator ---- @@ -3975,7 +3977,7 @@ If ``true``, display OpenType features marked as ``hidden`` by the font file in :ref:`bool` **interface/multi_window/enable** :ref:`🔗` -If ``true``, multiple window support in editor is enabled. The following panels can become dedicated windows (i.e. made floating): Docks, Script editor, and Shader editor. +If ``true``, multiple window support in editor is enabled. The following panels can become dedicated windows (i.e. made floating): Docks, Script editor, Shader editor, and Game Workspace. \ **Note:** When :ref:`interface/editor/single_window_mode` is ``true``, the multi window support is always disabled. @@ -4617,6 +4619,8 @@ Specifies the picture-in-picture (PiP) mode for the Play window. The window mode to use to display the project when starting the project from the editor. +\ **Note:** Game embedding is not available for "Force Maximized" or "Force Fullscreen." + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index e61463845..d915c4f10 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -31,23 +31,25 @@ Properties .. table:: :widths: auto - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`flat` | ``false`` | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`hide_slider` | ``false`` | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`label` | ``""`` | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`read_only` | ``false`` | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`suffix` | ``""`` | - +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editing_integer` | ``false`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`flat` | ``false`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_slider` | ``false`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`label` | ``""`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`read_only` | ``false`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`suffix` | ``""`` | + +--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -137,6 +139,23 @@ Emitted when the value form loses focus. Property Descriptions --------------------- +.. _class_EditorSpinSlider_property_editing_integer: + +.. rst-class:: classref-property + +:ref:`bool` **editing_integer** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_editing_integer**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editing_integer**\ (\ ) + +If ``true``, the **EditorSpinSlider** is considered to be editing an integer value. If ``false``, the **EditorSpinSlider** is considered to be editing a floating-point value. This is used to determine whether a slider should be drawn. The slider is only drawn for floats; integers use up-down arrows similar to :ref:`SpinBox` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSpinSlider_property_flat: .. rst-class:: classref-property diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index d8168caa1..30094e829 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -48,6 +48,8 @@ Properties +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | ok_button_text | ``"Save"`` (overrides :ref:`AcceptDialog`) | + +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`option_count` | ``0`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`root_subfolder` | ``""`` | diff --git a/classes/class_input.rst b/classes/class_input.rst index 06da22d96..a49efe239 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -228,6 +228,14 @@ Confines the mouse cursor to the game window, and make it visible. Confines the mouse cursor to the game window, and make it hidden. +.. _class_Input_constant_MOUSE_MODE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseMode` **MOUSE_MODE_MAX** = ``5`` + +Max value of the :ref:`MouseMode`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index bfcd64281..08933f39a 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -890,7 +890,7 @@ If ``false``, existing text cannot be modified and new text cannot be added. - |void| **set_emoji_menu_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_emoji_menu_enabled**\ (\ ) -If ``false``, "Emoji and Symbols" menu is enabled. +If ``true``, "Emoji and Symbols" menu is enabled. .. rst-class:: classref-item-separator diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 4cd9cc09f..7bedee33d 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -4278,6 +4278,8 @@ Main window initial screen, this setting is used only if :ref:`display/window/si Main window mode. See :ref:`WindowMode` for possible values and how each mode behaves. +\ **Note:** Game embedding is available only in the "Windowed" mode. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index d112fa6f1..1cff21927 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -23,6 +23,8 @@ Description \ **Note:** **SubViewport** is a :ref:`Viewport` that isn't a :ref:`Window`, i.e. it doesn't draw anything by itself. To display anything, **SubViewport** must have a non-zero size and be either put inside a :ref:`SubViewportContainer` or assigned to a :ref:`ViewportTexture`. +\ **Note:** :ref:`InputEvent`\ s are not passed to a standalone **SubViewport** by default. To ensure :ref:`InputEvent` propagation, a **SubViewport** can be placed inside of a :ref:`SubViewportContainer`. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 894d98c34..6911340f8 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -1384,7 +1384,7 @@ If ``false``, existing text cannot be modified and new text cannot be added. - |void| **set_emoji_menu_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_emoji_menu_enabled**\ (\ ) -If ``false``, "Emoji and Symbols" menu is enabled. +If ``true``, "Emoji and Symbols" menu is enabled. .. rst-class:: classref-item-separator