godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10595 from godotengine/classref/sync-1586c56

Browse Source 
classref: Sync with current master branch (1586c56)
This commit is contained in:
Max Hilbrunner
2025-02-01 11:39:42 +01:00
committed by GitHub
parent 3e17624c6f 1c1e1c11bb
commit 4e0d941cd8
13 changed files with 87 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
classes/class_cpuparticles2d.rst
View File

@@ -738,7 +738,7 @@ Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_te
- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_initial_ramp**\ (\ )
Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
Each particle's initial color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
.. rst-class:: classref-item-separator
@@ -755,7 +755,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D<class
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` over its lifetime (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
.. rst-class:: classref-item-separator

4
classes/class_cpuparticles3d.rst
View File

@@ -774,7 +774,7 @@ Each particle's initial color.
- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_initial_ramp**\ (\ )
Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
Each particle's initial color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
\ **Note:** :ref:`color_initial_ramp<class_CPUParticles3D_property_color_initial_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp<class_CPUParticles3D_property_color_initial_ramp>` will have no visible effect.
@@ -793,7 +793,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D<class
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` over its lifetime (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
\ **Note:** :ref:`color_ramp<class_CPUParticles3D_property_color_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp<class_CPUParticles3D_property_color_ramp>` will have no visible effect.

8
classes/class_displayserver.rst
View File

@@ -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<enum_DisplayServer_MouseMode>` **MOUSE_MODE_MAX** = ``5``
Max value of the :ref:`MouseMode<enum_DisplayServer_MouseMode>`.
.. rst-class:: classref-item-separator
----

34
classes/class_editorexportplatformandroid.rst
View File

@@ -54,6 +54,8 @@ Properties
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformAndroid_property_custom_template/release>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gesture/swipe_to_dismiss<class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`gradle_build/android_source_template<class_EditorExportPlatformAndroid_property_gradle_build/android_source_template>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gradle_build/compress_native_libraries<class_EditorExportPlatformAndroid_property_gradle_build/compress_native_libraries>` |
@@ -430,8 +432,6 @@ Properties
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`version/name<class_EditorExportPlatformAndroid_property_version/name>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`wear_os/swipe_to_dismiss<class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`xr_features/xr_mode<class_EditorExportPlatformAndroid_property_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<class_bool>` **gesture/swipe_to_dismiss** :ref:`🔗<class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss>`
If ``true``, `Swipe to dismiss <https://developer.android.com/design/ui/wear/guides/components/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<class_EditorExportPlatformAndroid_property_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<class_bool>` **wear_os/swipe_to_dismiss** :ref:`🔗<class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss>`
If ``true``, `Swipe to dismiss <https://developer.android.com/design/ui/wear/guides/components/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<class_EditorExportPlatformAndroid_property_gradle_build/use_gradle_build>` is required.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformAndroid_property_xr_features/xr_mode:
.. rst-class:: classref-property

2
classes/class_editorinspector.rst
View File

@@ -44,8 +44,6 @@ Properties
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | follow_focus | ``true`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_follow_focus>`) |
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`ScrollMode<enum_ScrollContainer_ScrollMode>` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_horizontal_scroll_mode>`) |
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+

6
classes/class_editorsettings.rst
View File

@@ -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<class_EditorInterface_method_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<class_bool>` **interface/multi_window/enable** :ref:`🔗<class_EditorSettings_property_interface/multi_window/enable>`
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<class_EditorSettings_property_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
----

53
classes/class_editorspinslider.rst
View File

@@ -31,23 +31,25 @@ Properties
.. table::
:widths: auto
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flat<class_EditorSpinSlider_property_flat>` | ``false`` |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hide_slider<class_EditorSpinSlider_property_hide_slider>` | ``false`` |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`label<class_EditorSpinSlider_property_label>` | ``""`` |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorSpinSlider_property_read_only>` | ``false`` |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| |bitfield|\[:ref:`SizeFlags<enum_Control_SizeFlags>`\] | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``1.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`suffix<class_EditorSpinSlider_property_suffix>` | ``""`` |
+--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editing_integer<class_EditorSpinSlider_property_editing_integer>` | ``false`` |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flat<class_EditorSpinSlider_property_flat>` | ``false`` |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hide_slider<class_EditorSpinSlider_property_hide_slider>` | ``false`` |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`label<class_EditorSpinSlider_property_label>` | ``""`` |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorSpinSlider_property_read_only>` | ``false`` |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| |bitfield|\[:ref:`SizeFlags<enum_Control_SizeFlags>`\] | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``1.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+--------------------------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`suffix<class_EditorSpinSlider_property_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<class_bool>` **editing_integer** = ``false`` :ref:`🔗<class_EditorSpinSlider_property_editing_integer>`
.. rst-class:: classref-property-setget
- |void| **set_editing_integer**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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<class_SpinBox>` instead.
.. rst-class:: classref-item-separator
----
.. _class_EditorSpinSlider_property_flat:
.. rst-class:: classref-property

2
classes/class_filedialog.rst
View File

@@ -48,6 +48,8 @@ Properties
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | ok_button_text | ``"Save"`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_ok_button_text>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`option_count<class_FileDialog_property_option_count>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_subfolder<class_FileDialog_property_root_subfolder>` | ``""`` |

8
classes/class_input.rst
View File

@@ -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<enum_Input_MouseMode>` **MOUSE_MODE_MAX** = ``5``
Max value of the :ref:`MouseMode<enum_Input_MouseMode>`.
.. rst-class:: classref-item-separator
----

2
classes/class_lineedit.rst
View File

@@ -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<class_bool>`\ )
- :ref:`bool<class_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

2
classes/class_projectsettings.rst
View File

@@ -4278,6 +4278,8 @@ Main window initial screen, this setting is used only if :ref:`display/window/si
Main window mode. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
\ **Note:** Game embedding is available only in the "Windowed" mode.
.. rst-class:: classref-item-separator
----

2
classes/class_subviewport.rst
View File

@@ -23,6 +23,8 @@ Description
\ **Note:** **SubViewport** is a :ref:`Viewport<class_Viewport>` that isn't a :ref:`Window<class_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<class_SubViewportContainer>` or assigned to a :ref:`ViewportTexture<class_ViewportTexture>`.
\ **Note:** :ref:`InputEvent<class_InputEvent>`\ s are not passed to a standalone **SubViewport** by default. To ensure :ref:`InputEvent<class_InputEvent>` propagation, a **SubViewport** can be placed inside of a :ref:`SubViewportContainer<class_SubViewportContainer>`.
.. rst-class:: classref-introduction-group
Tutorials

2
classes/class_textedit.rst
View File

@@ -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<class_bool>`\ )
- :ref:`bool<class_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