Skip to content

Commit 4e0d941

Browse files
authored
Merge pull request #10595 from godotengine/classref/sync-1586c56
classref: Sync with current master branch (1586c56)
2 parents 3e17624 + 1c1e1c1 commit 4e0d941

13 files changed

+87
-42
lines changed

classes/class_cpuparticles2d.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_te
738738
- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
739739
- :ref:`Gradient<class_Gradient>` **get_color_initial_ramp**\ (\ )
740740

741-
Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
741+
Each particle's initial color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
742742

743743
.. rst-class:: classref-item-separator
744744

@@ -755,7 +755,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D<class
755755
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
756756
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
757757

758-
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
758+
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` over its lifetime (multiplied with :ref:`color<class_CPUParticles2D_property_color>`).
759759

760760
.. rst-class:: classref-item-separator
761761

classes/class_cpuparticles3d.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ Each particle's initial color.
774774
- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
775775
- :ref:`Gradient<class_Gradient>` **get_color_initial_ramp**\ (\ )
776776

777-
Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
777+
Each particle's initial color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
778778

779779
\ **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.
780780

@@ -793,7 +793,7 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D<class
793793
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
794794
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
795795

796-
Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
796+
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` over its lifetime (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
797797

798798
\ **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.
799799

classes/class_displayserver.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,14 @@ Confines the mouse cursor to the game window, and make it visible.
730730

731731
Confines the mouse cursor to the game window, and make it hidden.
732732

733+
.. _class_DisplayServer_constant_MOUSE_MODE_MAX:
734+
735+
.. rst-class:: classref-enumeration-constant
736+
737+
:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_MAX** = ``5``
738+
739+
Max value of the :ref:`MouseMode<enum_DisplayServer_MouseMode>`.
740+
733741
.. rst-class:: classref-item-separator
734742

735743
----

classes/class_editorexportplatformandroid.rst

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Properties
5454
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
5555
| :ref:`String<class_String>` | :ref:`custom_template/release<class_EditorExportPlatformAndroid_property_custom_template/release>` |
5656
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
57+
| :ref:`bool<class_bool>` | :ref:`gesture/swipe_to_dismiss<class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss>` |
58+
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
5759
| :ref:`String<class_String>` | :ref:`gradle_build/android_source_template<class_EditorExportPlatformAndroid_property_gradle_build/android_source_template>` |
5860
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
5961
| :ref:`bool<class_bool>` | :ref:`gradle_build/compress_native_libraries<class_EditorExportPlatformAndroid_property_gradle_build/compress_native_libraries>` |
@@ -430,8 +432,6 @@ Properties
430432
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
431433
| :ref:`String<class_String>` | :ref:`version/name<class_EditorExportPlatformAndroid_property_version/name>` |
432434
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
433-
| :ref:`bool<class_bool>` | :ref:`wear_os/swipe_to_dismiss<class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss>` |
434-
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
435435
| :ref:`int<class_int>` | :ref:`xr_features/xr_mode<class_EditorExportPlatformAndroid_property_xr_features/xr_mode>` |
436436
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
437437

@@ -570,6 +570,22 @@ Path to an APK file to use as a custom export template for release exports. If l
570570

571571
----
572572

573+
.. _class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss:
574+
575+
.. rst-class:: classref-property
576+
577+
:ref:`bool<class_bool>` **gesture/swipe_to_dismiss** :ref:`🔗<class_EditorExportPlatformAndroid_property_gesture/swipe_to_dismiss>`
578+
579+
If ``true``, `Swipe to dismiss <https://developer.android.com/design/ui/wear/guides/components/swipe-to-dismiss>`__ will be enabled.
580+
581+
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.
582+
583+
\ **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.
584+
585+
.. rst-class:: classref-item-separator
586+
587+
----
588+
573589
.. _class_EditorExportPlatformAndroid_property_gradle_build/android_source_template:
574590

575591
.. rst-class:: classref-property
@@ -2862,20 +2878,6 @@ Application version visible to the user. Falls back to :ref:`ProjectSettings.app
28622878

28632879
----
28642880

2865-
.. _class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss:
2866-
2867-
.. rst-class:: classref-property
2868-
2869-
:ref:`bool<class_bool>` **wear_os/swipe_to_dismiss** :ref:`🔗<class_EditorExportPlatformAndroid_property_wear_os/swipe_to_dismiss>`
2870-
2871-
If ``true``, `Swipe to dismiss <https://developer.android.com/design/ui/wear/guides/components/swipe-to-dismiss>`__ will be enabled on Wear OS.
2872-
2873-
\ **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.
2874-
2875-
.. rst-class:: classref-item-separator
2876-
2877-
----
2878-
28792881
.. _class_EditorExportPlatformAndroid_property_xr_features/xr_mode:
28802882

28812883
.. rst-class:: classref-property

classes/class_editorinspector.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ Properties
4444
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
4545
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
4646
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
47-
| :ref:`bool<class_bool>` | follow_focus | ``true`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_follow_focus>`) |
48-
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
4947
| :ref:`ScrollMode<enum_ScrollContainer_ScrollMode>` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer<class_ScrollContainer_property_horizontal_scroll_mode>`) |
5048
+----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
5149

classes/class_editorsettings.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3661,6 +3661,8 @@ This is equivalent to :ref:`ProjectSettings.display/window/subwindows/embed_subw
36613661

36623662
\ **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.
36633663

3664+
\ **Note:** If ``true``, game embedding is disabled.
3665+
36643666
.. rst-class:: classref-item-separator
36653667

36663668
----
@@ -3975,7 +3977,7 @@ If ``true``, display OpenType features marked as ``hidden`` by the font file in
39753977

39763978
:ref:`bool<class_bool>` **interface/multi_window/enable** :ref:`🔗<class_EditorSettings_property_interface/multi_window/enable>`
39773979

3978-
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.
3980+
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.
39793981

39803982
\ **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.
39813983

@@ -4617,6 +4619,8 @@ Specifies the picture-in-picture (PiP) mode for the Play window.
46174619

46184620
The window mode to use to display the project when starting the project from the editor.
46194621

4622+
\ **Note:** Game embedding is not available for "Force Maximized" or "Force Fullscreen."
4623+
46204624
.. rst-class:: classref-item-separator
46214625

46224626
----

0 commit comments

Comments
 (0)