diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index f0ee59053..1cce5ee7d 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -3860,6 +3860,8 @@ Sets a custom mouse cursor image for the given ``shape``. This means the user's \ ``cursor`` can be either a :ref:`Texture2D` or an :ref:`Image`, and it should not be larger than 256×256 to display correctly. Optionally, ``hotspot`` can be set to offset the image's position relative to the click point. By default, ``hotspot`` is set to the top-left corner of the image. See also :ref:`cursor_set_shape()`. +\ **Note:** On Web, calling this method every frame can cause the cursor to flicker. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 8a22beb25..d7c074419 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -25,13 +25,6 @@ Base resource that provides the functionality of exporting a release build of a Used in scripting by :ref:`EditorExportPlugin` to configure platform-specific customization of scenes and resources. See :ref:`EditorExportPlugin._begin_customize_scenes()` and :ref:`EditorExportPlugin._begin_customize_resources()` for more details. -.. rst-class:: classref-introduction-group - -Tutorials ---------- - -- :doc:`Console support in Godot <../tutorials/platform/consoles>` - .. rst-class:: classref-reftable-group Methods diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index da49837fe..0ce62f301 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -219,6 +219,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d/selection_box_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/show_gizmo_during_rotation` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/aabb` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/camera` | @@ -2041,6 +2043,18 @@ The color to use for the selection box that surrounds selected nodes in the 3D e ---- +.. _class_EditorSettings_property_editors/3d/show_gizmo_during_rotation: + +.. rst-class:: classref-property + +:ref:`int` **editors/3d/show_gizmo_during_rotation** :ref:`🔗` + +If checked, the transform gizmo remains visible during rotation in that transform mode. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/aabb: .. rst-class:: classref-property diff --git a/classes/class_input.rst b/classes/class_input.rst index c35e903cf..1b865e82e 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -147,7 +147,7 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_gyroscope`\ (\ value\: :ref:`Vector3`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_joy_light`\ (\ device\: :ref:`int`, color\: :ref:`Color`\ ) | + | |void| | :ref:`set_joy_light`\ (\ device\: :ref:`int`, color\: :ref:`Color`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_magnetometer`\ (\ value\: :ref:`Vector3`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1137,9 +1137,9 @@ Sets the value of the rotation rate of the gyroscope sensor. Can be used for deb .. rst-class:: classref-method -:ref:`bool` **set_joy_light**\ (\ device\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` +|void| **set_joy_light**\ (\ device\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` -Sets the joypad's LED light, if available, to the specified color. Returns ``true`` if the operation was successful. See also :ref:`has_joy_light()`. +Sets the joypad's LED light, if available, to the specified color. See also :ref:`has_joy_light()`. \ **Note:** There is no way to get the color of the light from a joypad. If you need to know the assigned color, store it separately. diff --git a/classes/class_lookatmodifier3d.rst b/classes/class_lookatmodifier3d.rst index ee96acce8..122d4963a 100644 --- a/classes/class_lookatmodifier3d.rst +++ b/classes/class_lookatmodifier3d.rst @@ -386,7 +386,7 @@ If ``1.0``, no damping is performed. If ``0.0``, damping is always performed. - |void| **set_primary_limit_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_primary_limit_angle**\ (\ ) -The limit angle of the primary rotation when :ref:`symmetry_limitation` is ``true``. +The limit angle of the primary rotation when :ref:`symmetry_limitation` is ``true``, in radians. .. rst-class:: classref-item-separator @@ -420,7 +420,7 @@ The threshold to start damping for :ref:`primary_negative_limit_angle`\ ) - :ref:`float` **get_primary_negative_limit_angle**\ (\ ) -The limit angle of negative side of the primary rotation when :ref:`symmetry_limitation` is ``false``. +The limit angle of negative side of the primary rotation when :ref:`symmetry_limitation` is ``false``, in radians. .. rst-class:: classref-item-separator @@ -454,7 +454,7 @@ The threshold to start damping for :ref:`primary_positive_limit_angle`\ ) - :ref:`float` **get_primary_positive_limit_angle**\ (\ ) -The limit angle of positive side of the primary rotation when :ref:`symmetry_limitation` is ``false``. +The limit angle of positive side of the primary rotation when :ref:`symmetry_limitation` is ``false``, in radians. .. rst-class:: classref-item-separator @@ -522,7 +522,7 @@ The threshold to start damping for :ref:`secondary_limit_angle`\ ) - :ref:`float` **get_secondary_limit_angle**\ (\ ) -The limit angle of the secondary rotation when :ref:`symmetry_limitation` is ``true``. +The limit angle of the secondary rotation when :ref:`symmetry_limitation` is ``true``, in radians. .. rst-class:: classref-item-separator @@ -556,7 +556,7 @@ The threshold to start damping for :ref:`secondary_negative_limit_angle`\ ) - :ref:`float` **get_secondary_negative_limit_angle**\ (\ ) -The limit angle of negative side of the secondary rotation when :ref:`symmetry_limitation` is ``false``. +The limit angle of negative side of the secondary rotation when :ref:`symmetry_limitation` is ``false``, in radians. .. rst-class:: classref-item-separator @@ -590,7 +590,7 @@ The threshold to start damping for :ref:`secondary_positive_limit_angle`\ ) - :ref:`float` **get_secondary_positive_limit_angle**\ (\ ) -The limit angle of positive side of the secondary rotation when :ref:`symmetry_limitation` is ``false``. +The limit angle of positive side of the secondary rotation when :ref:`symmetry_limitation` is ``false``, in radians. .. rst-class:: classref-item-separator diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index d6d712b2e..0778f0592 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -5730,7 +5730,7 @@ Font glyph subpixel positioning mode for the default project font. See :ref:`Fon The default scale factor for :ref:`Control`\ s, when not overridden by a :ref:`Theme`. -\ **Note:** This property is only read when the project starts. To change the default scale at runtime, set :ref:`ThemeDB.fallback_base_scale` instead. +\ **Note:** This property is only read when the project starts. To change the default theme scale at runtime, set :ref:`ThemeDB.fallback_base_scale` instead. However, to adjust the scale of all 2D elements at runtime, it's preferable to use :ref:`Window.content_scale_factor` on the root :ref:`Window` node instead (as this also affects overridden :ref:`Theme`\ s). See :doc:`Multiple resolutions <../tutorials/rendering/multiple_resolutions>` in the documentation for details. .. rst-class:: classref-item-separator diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 308b5b2d0..8a72b15cc 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -21,12 +21,14 @@ Description A regular expression (or regex) is a compact language that can be used to recognize strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For example, a regex of ``ab[0-9]`` would find any string that is ``ab`` followed by any number from ``0`` to ``9``. For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet. -To begin, the RegEx object needs to be compiled with the search pattern using :ref:`compile()` before it can be used. +To begin, the RegEx object needs to be compiled with the search pattern using :ref:`compile()` before it can be used. Alternatively, the static method :ref:`create_from_string()` can be used to create and compile a RegEx object in a single method call. :: var regex = RegEx.new() regex.compile("\\w-(\\d+)") + # Shorthand to create and compile a regex (used in the examples below): + var regex2 = RegEx.create_from_string("\\w-(\\d+)") The search pattern must be escaped first for GDScript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"``. In GDScript, you can also use raw string literals (r-strings). For example, ``compile(r'"(?:\\.|[^"])*"')`` would be read the same. @@ -34,8 +36,7 @@ Using :ref:`search()`, you can find the pattern withi :: - var regex = RegEx.new() - regex.compile("\\w-(\\d+)") + var regex = RegEx.create_from_string("\\w-(\\d+)") var result = regex.search("abc n-0123") if result: print(result.get_string()) # Prints "n-0123" @@ -46,8 +47,7 @@ This version of RegEx also supports named capturing groups, and the names can be :: - var regex = RegEx.new() - regex.compile("d(?[0-9]+)|x(?[0-9a-f]+)") + var regex = RegEx.create_from_string("d(?[0-9]+)|x(?[0-9a-f]+)") var result = regex.search("the number is x2f") if result: print(result.get_string("digit")) # Prints "2f" @@ -64,8 +64,7 @@ If you need to process multiple results, :ref:`search_all()` | :ref:`button_margin` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`check_h_separation` | ``4`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`children_hl_line_width` | ``1`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`dragging_unfold_wait_msec` | ``500`` | @@ -241,6 +243,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`icon_h_separation` | ``4`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`icon_max_width` | ``0`` | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`inner_item_margin_bottom` | ``0`` | @@ -1666,6 +1670,18 @@ The horizontal space between each button in a cell. ---- +.. _class_Tree_theme_constant_check_h_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **check_h_separation** = ``4`` :ref:`🔗` + +The horizontal space between the checkbox and the text in a :ref:`TreeItem.CELL_MODE_CHECK` mode cell. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_constant_children_hl_line_width: .. rst-class:: classref-themeproperty @@ -1726,6 +1742,18 @@ The horizontal space between item cells. This is also used as the margin at the ---- +.. _class_Tree_theme_constant_icon_h_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_h_separation** = ``4`` :ref:`🔗` + +The horizontal space between the icon and the text in item's cells. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_constant_icon_max_width: .. rst-class:: classref-themeproperty