From ec62d34434cd54fc9fd912495fe4b94c7753320f Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Thu, 28 Sep 2023 11:42:41 +0000 Subject: [PATCH] classref: Sync with current master branch (4c3dc26) --- classes/class_@gdscript.rst | 4 +- classes/class_@globalscope.rst | 2 +- classes/class_basis.rst | 14 + classes/class_button.rst | 194 ++++++-- classes/class_canvasitem.rst | 2 +- classes/class_canvaslayer.rst | 2 + classes/class_charfxtransform.rst | 69 ++- classes/class_checkbox.rst | 278 +---------- classes/class_checkbutton.rst | 278 +---------- classes/class_codeedit.rst | 440 +++--------------- classes/class_colorpicker.rst | 2 +- classes/class_colorpickerbutton.rst | 218 +-------- classes/class_control.rst | 18 + classes/class_displayserver.rst | 4 +- classes/class_editorfiledialog.rst | 14 + classes/class_editorinspector.rst | 14 + classes/class_gdextensionmanager.rst | 17 + classes/class_gltfdocument.rst | 70 ++- classes/class_gltfdocumentextension.rst | 2 + classes/class_graphelement.rst | 29 ++ classes/class_graphnode.rst | 14 - classes/class_hboxcontainer.rst | 29 -- classes/class_hflowcontainer.rst | 43 -- classes/class_hscrollbar.rst | 169 ------- classes/class_hseparator.rst | 43 -- classes/class_hslider.rst | 141 ------ classes/class_hsplitcontainer.rst | 71 --- classes/class_image.rst | 8 +- classes/class_importermeshinstance3d.rst | 161 ++++++- classes/class_lightmapgi.rst | 23 +- classes/class_linkbutton.rst | 70 ++- classes/class_menubar.rst | 78 +++- classes/class_menubutton.rst | 227 --------- ...ass_navigationmeshsourcegeometrydata2d.rst | 157 +++++++ classes/class_navigationpolygon.rst | 282 +++++++++-- classes/class_navigationregion2d.rst | 43 ++ classes/class_navigationserver2d.rst | 436 +++++++++-------- classes/class_node.rst | 2 + classes/class_openxrinterface.rst | 64 ++- classes/class_optionbutton.rst | 296 +----------- classes/class_packedbytearray.rst | 10 +- classes/class_physicsserver2d.rst | 78 ++++ classes/class_physicsserver2dextension.rst | 32 ++ classes/class_pinjoint2d.rst | 101 +++- classes/class_popup.rst | 29 ++ classes/class_popupmenu.rst | 34 +- classes/class_popuppanel.rst | 29 -- classes/class_progressbar.rst | 14 - classes/class_projectsettings.rst | 44 ++ classes/class_renderingdevice.rst | 14 + classes/class_renderingserver.rst | 18 +- classes/class_renderscenebuffersrd.rst | 14 + classes/class_resource.rst | 35 +- classes/class_richtextlabel.rst | 366 +++++++++------ classes/class_scenetree.rst | 6 +- classes/class_script.rst | 14 + classes/class_scriptextension.rst | 14 + classes/class_scriptlanguageextension.rst | 4 +- classes/class_scrollbar.rst | 185 ++++++++ classes/class_separator.rst | 43 ++ classes/class_slider.rst | 141 ++++++ classes/class_splitcontainer.rst | 14 + classes/class_string.rst | 10 +- classes/class_tabbar.rst | 92 +++- classes/class_tabcontainer.rst | 79 ++++ classes/class_tilemap.rst | 6 +- classes/class_transform2d.rst | 14 + classes/class_vboxcontainer.rst | 29 -- classes/class_vflowcontainer.rst | 43 -- classes/class_viewport.rst | 18 +- classes/class_vscrollbar.rst | 169 ------- classes/class_vseparator.rst | 43 -- classes/class_vslider.rst | 141 ------ classes/class_vsplitcontainer.rst | 71 --- classes/index.rst | 1 + 75 files changed, 2739 insertions(+), 3244 deletions(-) create mode 100644 classes/class_navigationmeshsourcegeometrydata2d.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 0c7f6e18d62..75519c600f8 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -572,7 +572,7 @@ Export an :ref:`int` or :ref:`float` property as a range If hints ``"or_greater"`` and ``"or_less"`` are provided, the editor widget will not cap the value at range boundaries. The ``"exp"`` hint will make the edited values on range to change exponentially. The ``"hide_slider"`` hint will hide the slider element of the editor widget. -Hints also allow to indicate the units for the edited value. Using ``"radians"`` you can specify that the actual value is in radians, but should be displayed in degrees in the Inspector dock. ``"degrees"`` allows to add a degree sign as a unit suffix. Finally, a custom suffix can be provided using ``"suffix:unit"``, where "unit" can be any string. +Hints also allow to indicate the units for the edited value. Using ``"radians_as_degrees"`` you can specify that the actual value is in radians, but should be displayed in degrees in the Inspector dock (the range values are also in degrees). ``"degrees"`` allows to add a degree sign as a unit suffix (the value is unchanged). Finally, a custom suffix can be provided using ``"suffix:unit"``, where "unit" can be any string. See also :ref:`@GlobalScope.PROPERTY_HINT_RANGE`. @@ -585,7 +585,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_RANGE` or :ref:`float` property should \ **Example:** ``"-360,360,1,or_greater,or_less"``. -Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians"`` for editing radian angles in degrees, ``"degrees"`` to hint at an angle and ``"hide_slider"`` to hide the slider. +Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians_as_degrees"`` for editing radian angles in degrees (the range values are also in degrees), ``"degrees"`` to hint at an angle and ``"hide_slider"`` to hide the slider. .. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 475dffb2518..6b18d92eda3 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -107,6 +107,8 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`inverse` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_conformal` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | @@ -392,6 +394,18 @@ Returns the inverse of the matrix. ---- +.. _class_Basis_method_is_conformal: + +.. rst-class:: classref-method + +:ref:`bool` **is_conformal** **(** **)** |const| + +Returns ``true`` if the basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returns ``false`` if the basis has non-uniform scale or shear/skew. This can be used to validate if the basis is non-distorted, which is important for physics and other use cases. + +.. rst-class:: classref-item-separator + +---- + .. _class_Basis_method_is_equal_approx: .. rst-class:: classref-method diff --git a/classes/class_button.rst b/classes/class_button.rst index f7ed65ef092..6f5ddc2ede6 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -109,53 +109,67 @@ Theme Properties .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_disabled_color` | ``Color(1, 1, 1, 0.4)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_focus_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_hover_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_normal_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`icon_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`icon_max_width` | ``0`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Font` | :ref:`font` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_disabled_color` | ``Color(1, 1, 1, 0.4)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_focus_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_hover_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_normal_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`icon_pressed_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`h_separation` | ``4`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Font` | :ref:`font` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`font_size` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Texture2D` | :ref:`icon` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`disabled` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`disabled_mirrored` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_mirrored` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_pressed` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_pressed_mirrored` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`normal` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`normal_mirrored` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`pressed` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`pressed_mirrored` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ .. rst-class:: classref-section-separator @@ -578,6 +592,20 @@ Font size of the **Button**'s text. ---- +.. _class_Button_theme_icon_icon: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **icon** + +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_style_disabled: .. rst-class:: classref-themeproperty @@ -590,6 +618,18 @@ Font size of the **Button**'s text. ---- +.. _class_Button_theme_style_disabled_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **disabled_mirrored** + +:ref:`StyleBox` used when the **Button** is disabled (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_style_focus: .. rst-class:: classref-themeproperty @@ -614,6 +654,42 @@ Font size of the **Button**'s text. ---- +.. _class_Button_theme_style_hover_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_mirrored** + +:ref:`StyleBox` used when the **Button** is being hovered (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + +.. _class_Button_theme_style_hover_pressed: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_pressed** + +:ref:`StyleBox` used when the **Button** is being pressed and hovered at the same time. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Button_theme_style_hover_pressed_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_pressed_mirrored** + +:ref:`StyleBox` used when the **Button** is being pressed and hovered at the same time (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_style_normal: .. rst-class:: classref-themeproperty @@ -626,6 +702,18 @@ Default :ref:`StyleBox` for the **Button**. ---- +.. _class_Button_theme_style_normal_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **normal_mirrored** + +Default :ref:`StyleBox` for the **Button** (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_style_pressed: .. rst-class:: classref-themeproperty @@ -634,6 +722,18 @@ Default :ref:`StyleBox` for the **Button**. :ref:`StyleBox` used when the **Button** is being pressed. +.. rst-class:: classref-item-separator + +---- + +.. _class_Button_theme_style_pressed_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **pressed_mirrored** + +:ref:`StyleBox` used when the **Button** is being pressed (for right-to-left layouts). + .. |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_canvasitem.rst b/classes/class_canvasitem.rst index 71c44eed8dd..faa2fbe47f2 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -25,7 +25,7 @@ Abstract base class for everything in 2D space. Canvas items are laid out in a t Any **CanvasItem** can draw. For this, :ref:`queue_redraw` is called by the engine, then :ref:`NOTIFICATION_DRAW` will be received on idle time to request a redraw. Because of this, canvas items don't need to be redrawn on every frame, improving the performance significantly. Several functions for drawing on the **CanvasItem** are provided (see ``draw_*`` functions). However, they can only be used inside :ref:`_draw`, its corresponding :ref:`Object._notification` or methods connected to the :ref:`draw` signal. -Canvas items are drawn in tree order. By default, children are on top of their parents, so a root **CanvasItem** will be drawn behind everything. This behavior can be changed on a per-item basis. +Canvas items are drawn in tree order on their canvas layer. By default, children are on top of their parents, so a root **CanvasItem** will be drawn behind everything. This behavior can be changed on a per-item basis. A **CanvasItem** can be hidden, which will also hide its children. By adjusting various other properties of a **CanvasItem**, you can also modulate its color (via :ref:`modulate` or :ref:`self_modulate`), change its Z-index, blend mode, and more. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index da81db3f059..9078e14198d 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -178,6 +178,8 @@ Scales the layer when using :ref:`follow_viewport_enabled` children of one CanvasLayer are drawn behind the :ref:`CanvasItem` children of the other CanvasLayer. Which CanvasLayer is drawn in front is non-deterministic. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index c13d789d91a..17c130e8f28 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -38,31 +38,33 @@ Properties .. table:: :widths: auto - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`elapsed_time` | ``0.0`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`Dictionary` | :ref:`env` | ``{}`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`RID` | :ref:`font` | ``RID()`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`glyph_count` | ``0`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`glyph_flags` | ``0`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`glyph_index` | ``0`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`outline` | ``false`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`Vector2i` | :ref:`range` | ``Vector2i(0, 0)`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`relative_index` | ``0`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`visible` | ``true`` | - +-------------------------------------+----------------------------------------------------------------------+-----------------------+ + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`elapsed_time` | ``0.0`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`Dictionary` | :ref:`env` | ``{}`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`RID` | :ref:`font` | ``RID()`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`glyph_count` | ``0`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`glyph_flags` | ``0`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`glyph_index` | ``0`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`outline` | ``false`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`Vector2i` | :ref:`range` | ``Vector2i(0, 0)`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`relative_index` | ``0`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`Transform2D` | :ref:`transform` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`visible` | ``true`` | + +---------------------------------------+----------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -268,6 +270,23 @@ The character offset of the glyph, relative to the current :ref:`RichTextEffect< ---- +.. _class_CharFXTransform_property_transform: + +.. rst-class:: classref-property + +:ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_transform** **(** :ref:`Transform2D` value **)** +- :ref:`Transform2D` **get_transform** **(** **)** + +The current transform of the current glyph. It can be overridden (for example, by driving the position and rotation from a curve). You can also alter the existing value to apply transforms on top of other effects. + +.. rst-class:: classref-item-separator + +---- + .. _class_CharFXTransform_property_visible: .. rst-class:: classref-property diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index fe21e8a17bd..c5cf9502a45 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -47,59 +47,25 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Font` | :ref:`font` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`radio_checked` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`radio_unchecked` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover_pressed` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`radio_checked` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`radio_unchecked` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+-------------------------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator @@ -110,90 +76,6 @@ Theme Properties Theme Property Descriptions --------------------------- -.. _class_CheckBox_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -The **CheckBox** text's font color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_disabled_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` - -The **CheckBox** text's font color when it's disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_focus_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -The **CheckBox** text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_hover_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -The **CheckBox** text's font color when it's hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_hover_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` - -The **CheckBox** text's font color when it's hovered and pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **CheckBox**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_color_font_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` - -The **CheckBox** text's font color when it's pressed. - -.. rst-class:: classref-item-separator - ----- - .. _class_CheckBox_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty @@ -206,56 +88,6 @@ The vertical offset used when rendering the check icons (in pixels). ---- -.. _class_CheckBox_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The separation between the check icon and the text (in pixels). Negative values will be treated as ``0`` when used. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -The :ref:`Font` to use for the **CheckBox** text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Font size of the **CheckBox**'s text. - -.. rst-class:: classref-item-separator - ----- - .. _class_CheckBox_theme_icon_checked: .. rst-class:: classref-themeproperty @@ -348,78 +180,6 @@ The check icon to display when the **CheckBox** is unchecked. The check icon to display when the **CheckBox** is unchecked and is disabled. -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled** - -The :ref:`StyleBox` to display as a background when the **CheckBox** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -The :ref:`StyleBox` to display as a background when the **CheckBox** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_hover: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover** - -The :ref:`StyleBox` to display as a background when the **CheckBox** is hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_hover_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover_pressed** - -The :ref:`StyleBox` to display as a background when the **CheckBox** is hovered and pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -The :ref:`StyleBox` to display as a background. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckBox_theme_style_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed** - -The :ref:`StyleBox` to display as a background when the **CheckBox** is pressed. - .. |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_checkbutton.rst b/classes/class_checkbutton.rst index ff938ed61b9..6eb1ff05d2d 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -45,59 +45,25 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Font` | :ref:`font` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`checked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover_pressed` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`checked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator @@ -108,90 +74,6 @@ Theme Properties Theme Property Descriptions --------------------------- -.. _class_CheckButton_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -The **CheckButton** text's font color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_disabled_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` - -The **CheckButton** text's font color when it's disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_focus_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -The **CheckButton** text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_hover_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -The **CheckButton** text's font color when it's hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_hover_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` - -The **CheckButton** text's font color when it's hovered and pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **CheckButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_color_font_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` - -The **CheckButton** text's font color when it's pressed. - -.. rst-class:: classref-item-separator - ----- - .. _class_CheckButton_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty @@ -204,56 +86,6 @@ The vertical offset used when rendering the toggle icons (in pixels). ---- -.. _class_CheckButton_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The separation between the toggle icon and the text (in pixels). Negative values will be treated as ``0`` when used. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -The :ref:`Font` to use for the **CheckButton** text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Font size of the **CheckButton**'s text. - -.. rst-class:: classref-item-separator - ----- - .. _class_CheckButton_theme_icon_checked: .. rst-class:: classref-themeproperty @@ -346,78 +178,6 @@ The icon to display when the **CheckButton** is unchecked and disabled (for righ The icon to display when the **CheckButton** is unchecked (for right-to-left layouts). -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled** - -The :ref:`StyleBox` to display as a background when the **CheckButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -The :ref:`StyleBox` to display as a background when the **CheckButton** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_hover: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover** - -The :ref:`StyleBox` to display as a background when the **CheckButton** is hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_hover_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover_pressed** - -The :ref:`StyleBox` to display as a background when the **CheckButton** is hovered and pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -The :ref:`StyleBox` to display as a background. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CheckButton_theme_style_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed** - -The :ref:`StyleBox` to display as a background when the **CheckButton** is pressed. - .. |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_codeedit.rst b/classes/class_codeedit.rst index e0beee072c5..2adf7e8c3a7 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -122,6 +122,8 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`do_indent` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`duplicate_lines` **(** **)** | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fold_all_lines` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fold_line` **(** :ref:`int` line **)** | @@ -227,103 +229,57 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`background_color` | ``Color(0, 0, 0, 0)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`bookmark_color` | ``Color(0.5, 0.64, 1, 0.8)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`brace_mismatch_color` | ``Color(1, 0.2, 0.2, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`breakpoint_color` | ``Color(0.9, 0.29, 0.3, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`caret_background_color` | ``Color(0, 0, 0, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`caret_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`code_folding_color` | ``Color(0.8, 0.8, 0.8, 0.8)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_background_color` | ``Color(0.17, 0.16, 0.2, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_existing_color` | ``Color(0.87, 0.87, 0.87, 0.13)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_font_color` | ``Color(0.67, 0.67, 0.67, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_scroll_color` | ``Color(1, 1, 1, 0.29)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_scroll_hovered_color` | ``Color(1, 1, 1, 0.4)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`completion_selected_color` | ``Color(0.26, 0.26, 0.27, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`current_line_color` | ``Color(0.25, 0.25, 0.26, 0.8)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`executing_line_color` | ``Color(0.98, 0.89, 0.27, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`folded_code_region_color` | ``Color(0.68, 0.46, 0.77, 0.2)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_placeholder_color` | ``Color(0.875, 0.875, 0.875, 0.6)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_readonly_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_selected_color` | ``Color(0, 0, 0, 0)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`line_length_guideline_color` | ``Color(0.3, 0.5, 0.8, 0.1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`line_number_color` | ``Color(0.67, 0.67, 0.67, 0.4)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`search_result_border_color` | ``Color(0.3, 0.3, 0.3, 0.4)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`search_result_color` | ``Color(0.3, 0.3, 0.3, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`selection_color` | ``Color(0.5, 0.5, 0.5, 1)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`word_highlighted_color` | ``Color(0.8, 0.9, 0.9, 0.15)`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`completion_lines` | ``7`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`completion_max_width` | ``50`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`completion_scroll_width` | ``6`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`line_spacing` | ``4`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Font` | :ref:`font` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`bookmark` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`breakpoint` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`can_fold` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`can_fold_code_region` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`executing_line` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`folded` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`folded_code_region` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`folded_eol_icon` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`space` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`tab` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`completion` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`read_only` | | - +-----------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`bookmark_color` | ``Color(0.5, 0.64, 1, 0.8)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`brace_mismatch_color` | ``Color(1, 0.2, 0.2, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`breakpoint_color` | ``Color(0.9, 0.29, 0.3, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`code_folding_color` | ``Color(0.8, 0.8, 0.8, 0.8)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`completion_background_color` | ``Color(0.17, 0.16, 0.2, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`completion_existing_color` | ``Color(0.87, 0.87, 0.87, 0.13)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`completion_scroll_color` | ``Color(1, 1, 1, 0.29)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`completion_scroll_hovered_color` | ``Color(1, 1, 1, 0.4)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`completion_selected_color` | ``Color(0.26, 0.26, 0.27, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`executing_line_color` | ``Color(0.98, 0.89, 0.27, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`folded_code_region_color` | ``Color(0.68, 0.46, 0.77, 0.2)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`line_length_guideline_color` | ``Color(0.3, 0.5, 0.8, 0.1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`line_number_color` | ``Color(0.67, 0.67, 0.67, 0.4)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`completion_lines` | ``7`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`completion_max_width` | ``50`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`completion_scroll_width` | ``6`` | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`bookmark` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`breakpoint` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`can_fold` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`can_fold_code_region` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`executing_line` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_code_region` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_eol_icon` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`completion` | | + +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -1109,6 +1065,18 @@ Perform an indent as if the user activated the "ui_text_indent" action. ---- +.. _class_CodeEdit_method_duplicate_lines: + +.. rst-class:: classref-method + +void **duplicate_lines** **(** **)** + +Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line. + +.. rst-class:: classref-item-separator + +---- + .. _class_CodeEdit_method_fold_all_lines: .. rst-class:: classref-method @@ -1704,18 +1672,6 @@ Submits all completion options added with :ref:`add_code_completion_option` **background_color** = ``Color(0, 0, 0, 0)`` - -Sets the background :ref:`Color`. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_color_bookmark_color: .. rst-class:: classref-themeproperty @@ -1752,30 +1708,6 @@ Sets the background :ref:`Color`. ---- -.. _class_CodeEdit_theme_color_caret_background_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **caret_background_color** = ``Color(0, 0, 0, 1)`` - -:ref:`Color` of the text behind the caret when block caret is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_caret_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **caret_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -:ref:`Color` of the caret. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_color_code_folding_color: .. rst-class:: classref-themeproperty @@ -1812,18 +1744,6 @@ Background highlight :ref:`Color` for matching text in code complet ---- -.. _class_CodeEdit_theme_color_completion_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **completion_font_color** = ``Color(0.67, 0.67, 0.67, 1)`` - -Font :ref:`Color` for the code completion popup. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_color_completion_scroll_color: .. rst-class:: classref-themeproperty @@ -1860,18 +1780,6 @@ Background highlight :ref:`Color` for the current selected option i ---- -.. _class_CodeEdit_theme_color_current_line_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **current_line_color** = ``Color(0.25, 0.25, 0.26, 0.8)`` - -Background :ref:`Color` of the line containing the caret. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_color_executing_line_color: .. rst-class:: classref-themeproperty @@ -1896,66 +1804,6 @@ Background :ref:`Color` of the line containing the caret. ---- -.. _class_CodeEdit_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -Sets the font :ref:`Color`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **CodeEdit**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_font_placeholder_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_placeholder_color** = ``Color(0.875, 0.875, 0.875, 0.6)`` - -Font color for :ref:`TextEdit.placeholder_text`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_font_readonly_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_readonly_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` - -Sets the font :ref:`Color` when :ref:`TextEdit.editable` is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_font_selected_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_selected_color** = ``Color(0, 0, 0, 0)`` - -Sets the :ref:`Color` of the selected text. If equal to ``Color(0, 0, 0, 0)``, it will be ignored. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_color_line_length_guideline_color: .. rst-class:: classref-themeproperty @@ -1980,54 +1828,6 @@ Sets the :ref:`Color` of line numbers. ---- -.. _class_CodeEdit_theme_color_search_result_border_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **search_result_border_color** = ``Color(0.3, 0.3, 0.3, 0.4)`` - -:ref:`Color` of the border around text that matches the search query. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_search_result_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **search_result_color** = ``Color(0.3, 0.3, 0.3, 1)`` - -:ref:`Color` behind the text that matches the search query. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_selection_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **selection_color** = ``Color(0.5, 0.5, 0.5, 1)`` - -Sets the highlight :ref:`Color` of text selections. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_color_word_highlighted_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **word_highlighted_color** = ``Color(0.8, 0.9, 0.9, 0.15)`` - -Sets the highlight :ref:`Color` of multiple occurrences. :ref:`TextEdit.highlight_all_occurrences` has to be enabled. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_constant_completion_lines: .. rst-class:: classref-themeproperty @@ -2064,56 +1864,6 @@ Width of the scrollbar in the code completion popup. ---- -.. _class_CodeEdit_theme_constant_line_spacing: - -.. rst-class:: classref-themeproperty - -:ref:`int` **line_spacing** = ``4`` - -Sets the spacing between the lines. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -Sets the default :ref:`Font`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Sets default font size. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_icon_bookmark: .. rst-class:: classref-themeproperty @@ -2210,30 +1960,6 @@ Sets a custom :ref:`Texture2D` to draw at the end of a folded l ---- -.. _class_CodeEdit_theme_icon_space: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **space** - -Sets a custom :ref:`Texture2D` for space text characters. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_icon_tab: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **tab** - -Sets a custom :ref:`Texture2D` for tab text characters. - -.. rst-class:: classref-item-separator - ----- - .. _class_CodeEdit_theme_style_completion: .. rst-class:: classref-themeproperty @@ -2242,42 +1968,6 @@ Sets a custom :ref:`Texture2D` for tab text characters. :ref:`StyleBox` for the code completion popup. -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -Sets the :ref:`StyleBox` when in focus. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -Sets the :ref:`StyleBox`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_CodeEdit_theme_style_read_only: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **read_only** - -Sets the :ref:`StyleBox` when :ref:`TextEdit.editable` is disabled. - .. |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_colorpicker.rst b/classes/class_colorpicker.rst index 7bf1435921c..aa5f8e9a898 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -562,7 +562,7 @@ Theme Property Descriptions :ref:`int` **center_slider_grabbers** = ``1`` -Overrides the :ref:`HSlider.center_grabber` theme property of the sliders. +Overrides the :ref:`Slider.center_grabber` theme property of the sliders. .. rst-class:: classref-item-separator diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 6593a363ac4..08ef4700487 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -72,39 +72,9 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.3)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(0.8, 0.8, 0.8, 1)`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Font` | :ref:`font` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Texture2D` | :ref:`bg` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ + +-----------------------------------+--------------------------------------------------+ + | :ref:`Texture2D` | :ref:`bg` | + +-----------------------------------+--------------------------------------------------+ .. rst-class:: classref-section-separator @@ -228,128 +198,6 @@ Returns the control's :ref:`PopupPanel` which allows you to co Theme Property Descriptions --------------------------- -.. _class_ColorPickerButton_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` - -Default text :ref:`Color` of the **ColorPickerButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_color_font_disabled_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_disabled_color** = ``Color(0.9, 0.9, 0.9, 0.3)`` - -Text :ref:`Color` used when the **ColorPickerButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_color_font_focus_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_focus_color** = ``Color(1, 1, 1, 1)`` - -Text :ref:`Color` used when the **ColorPickerButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_color_font_hover_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_color** = ``Color(1, 1, 1, 1)`` - -Text :ref:`Color` used when the **ColorPickerButton** is being hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **ColorPickerButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_color_font_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_pressed_color** = ``Color(0.8, 0.8, 0.8, 1)`` - -Text :ref:`Color` used when the **ColorPickerButton** is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The horizontal space between **ColorPickerButton**'s icon and text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -:ref:`Font` of the **ColorPickerButton**'s text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Font size of the **ColorPickerButton**'s text. - -.. rst-class:: classref-item-separator - ----- - .. _class_ColorPickerButton_theme_icon_bg: .. rst-class:: classref-themeproperty @@ -358,66 +206,6 @@ Font size of the **ColorPickerButton**'s text. The background of the color preview rect on the button. -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_style_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled** - -:ref:`StyleBox` used when the **ColorPickerButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -:ref:`StyleBox` used when the **ColorPickerButton** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_style_hover: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover** - -:ref:`StyleBox` used when the **ColorPickerButton** is being hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -Default :ref:`StyleBox` for the **ColorPickerButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ColorPickerButton_theme_style_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed** - -:ref:`StyleBox` used when the **ColorPickerButton** is being pressed. - .. |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_control.rst b/classes/class_control.rst index e1208f5240f..f8d37faa57b 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -193,6 +193,8 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`find_prev_valid_focus` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`find_valid_focus_neighbor` **(** :ref:`Side` side **)** |const| | + +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_anchor` **(** :ref:`Side` side **)** |const| | @@ -2366,6 +2368,20 @@ Finds the previous (above in the tree) **Control** that can receive the focus. ---- +.. _class_Control_method_find_valid_focus_neighbor: + +.. rst-class:: classref-method + +:ref:`Control` **find_valid_focus_neighbor** **(** :ref:`Side` side **)** |const| + +Finds the next **Control** that can receive the focus on the specified :ref:`Side`. + +\ **Note:** This is different from :ref:`get_focus_neighbor`, which returns the path of a specified focus neighbor. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_force_drag: .. rst-class:: classref-method @@ -2448,6 +2464,8 @@ Returns :ref:`offset_right` and :ref:`offse Returns the focus neighbor for the specified :ref:`Side`. A getter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. +\ **Note:** To find the next **Control** on the specific :ref:`Side`, even if a neighbor is not assigned, use :ref:`find_valid_focus_neighbor`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 24b3e3a5454..ddb0378d603 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -2557,7 +2557,7 @@ Returns the composition string contained within the `Input Method Editor ` **(** :ref:`String` filter, :ref:`String` description="" **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_side_menu` **(** :ref:`Control` menu, :ref:`String` title="" **)** | + +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_filters` **(** **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | @@ -412,6 +414,18 @@ For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Sce ---- +.. _class_EditorFileDialog_method_add_side_menu: + +.. rst-class:: classref-method + +void **add_side_menu** **(** :ref:`Control` menu, :ref:`String` title="" **)** + +Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorFileDialog_method_clear_filters: .. rst-class:: classref-method diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 6e2b29417d0..98b057acd41 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -51,6 +51,8 @@ Methods .. table:: :widths: auto + +-----------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_edited_object` **(** **)** | +-----------------------------+----------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_selected_path` **(** **)** |const| | +-----------------------------+----------------------------------------------------------------------------------------------+ @@ -179,6 +181,18 @@ Emitted when a property that requires a restart to be applied is edited in the i Method Descriptions ------------------- +.. _class_EditorInspector_method_get_edited_object: + +.. rst-class:: classref-method + +:ref:`Object` **get_edited_object** **(** **)** + +Returns the object currently selected in this inspector. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInspector_method_get_selected_path: .. rst-class:: classref-method diff --git a/classes/class_gdextensionmanager.rst b/classes/class_gdextensionmanager.rst index 7d0d47758a6..9c278824fb3 100644 --- a/classes/class_gdextensionmanager.rst +++ b/classes/class_gdextensionmanager.rst @@ -44,6 +44,23 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_GDExtensionManager_signal_extensions_reloaded: + +.. rst-class:: classref-signal + +**extensions_reloaded** **(** **)** + +Emitted after the editor has automatically reloaded any extensions. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index b8e25dbe15f..eea1ac1cb9b 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -42,11 +42,13 @@ Properties .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`image_format` | ``"PNG"`` | - +-----------------------------+-----------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lossy_quality` | ``0.75`` | - +-----------------------------+-----------------------------------------------------------------+-----------+ + +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`image_format` | ``"PNG"`` | + +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`lossy_quality` | ``0.75`` | + +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ + | :ref:`RootNodeMode` | :ref:`root_node_mode` | ``0`` | + +-----------------------------------------------------+-------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -80,6 +82,45 @@ Methods .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_GLTFDocument_RootNodeMode: + +.. rst-class:: classref-enumeration + +enum **RootNodeMode**: + +.. _class_GLTFDocument_constant_ROOT_NODE_MODE_SINGLE_ROOT: + +.. rst-class:: classref-enumeration-constant + +:ref:`RootNodeMode` **ROOT_NODE_MODE_SINGLE_ROOT** = ``0`` + +Treat the Godot scene's root node as the root node of the glTF file, and mark it as the single root node via the ``GODOT_single_root`` glTF extension. This will be parsed the same as :ref:`ROOT_NODE_MODE_KEEP_ROOT` if the implementation does not support ``GODOT_single_root``. + +.. _class_GLTFDocument_constant_ROOT_NODE_MODE_KEEP_ROOT: + +.. rst-class:: classref-enumeration-constant + +:ref:`RootNodeMode` **ROOT_NODE_MODE_KEEP_ROOT** = ``1`` + +Treat the Godot scene's root node as the root node of the glTF file, but do not mark it as anything special. An extra root node will be generated when importing into Godot. This uses only vanilla glTF features. This is equivalent to the behavior in Godot 4.1 and earlier. + +.. _class_GLTFDocument_constant_ROOT_NODE_MODE_MULTI_ROOT: + +.. rst-class:: classref-enumeration-constant + +:ref:`RootNodeMode` **ROOT_NODE_MODE_MULTI_ROOT** = ``2`` + +Treat the Godot scene's root node as the name of the glTF scene, and add all of its children as root nodes of the glTF file. This uses only vanilla glTF features. This avoids an extra root node, but only the name of the Godot scene's root node will be preserved, as it will not be saved as a node. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- @@ -115,6 +156,25 @@ By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless If :ref:`image_format` is a lossy image format, this determines the lossy quality of the image. On a range of ``0.0`` to ``1.0``, where ``0.0`` is the lowest quality and ``1.0`` is the highest quality. A lossy quality of ``1.0`` is not the same as lossless. +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFDocument_property_root_node_mode: + +.. rst-class:: classref-property + +:ref:`RootNodeMode` **root_node_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_root_node_mode** **(** :ref:`RootNodeMode` value **)** +- :ref:`RootNodeMode` **get_root_node_mode** **(** **)** + +How to process the root node during export. See :ref:`RootNodeMode` for details. The default and recommended value is :ref:`ROOT_NODE_MODE_SINGLE_ROOT`. + +\ **Note:** Regardless of how the glTF file is exported, when importing, the root node type and name can be overridden in the scene import settings tab. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index d006c0f00c6..5ce9ab0c864 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -164,6 +164,8 @@ Part of the import process. This method is run after :ref:`_import_post_parse` | :ref:`selected` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------+ +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +-----------------------------------+-------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`resizer` | + +-----------------------------------+-------------------------------------------------------+ + .. rst-class:: classref-section-separator ---- @@ -224,6 +236,23 @@ If ``true``, the user can select the GraphElement. If ``true``, the GraphElement is selected. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_GraphElement_theme_icon_resizer: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **resizer** + +The icon used for the resizer, visible when :ref:`resizable` is enabled. + .. |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_graphnode.rst b/classes/class_graphnode.rst index 2b73a712aeb..5547070cbf3 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -126,8 +126,6 @@ Theme Properties +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`Texture2D` | :ref:`port` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Texture2D` | :ref:`resizer` | | - +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel_selected` | | @@ -602,18 +600,6 @@ The icon used for representing ports. ---- -.. _class_GraphNode_theme_icon_resizer: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **resizer** - -The icon used for the resizer, visible when :ref:`GraphElement.resizable` is enabled. - -.. rst-class:: classref-item-separator - ----- - .. _class_GraphNode_theme_style_panel: .. rst-class:: classref-themeproperty diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index d6c59622bcd..7c94048cb44 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -30,35 +30,6 @@ Tutorials - :doc:`Using Containers <../tutorials/ui/gui_containers>` -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------+------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`separation` | ``4`` | - +-----------------------+------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HBoxContainer_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``4`` - -The horizontal space between the **HBoxContainer**'s elements. - .. |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_hflowcontainer.rst b/classes/class_hflowcontainer.rst index fbcadf8cd43..a2ff05310ff 100644 --- a/classes/class_hflowcontainer.rst +++ b/classes/class_hflowcontainer.rst @@ -28,49 +28,6 @@ Tutorials - :doc:`Using Containers <../tutorials/ui/gui_containers>` -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------+-----------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------+-----------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`v_separation` | ``4`` | - +-----------------------+-----------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HFlowContainer_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The horizontal separation of children nodes. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HFlowContainer_theme_constant_v_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **v_separation** = ``4`` - -The vertical separation of children nodes. - .. |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_hscrollbar.rst b/classes/class_hscrollbar.rst index 3c07f424060..a4193b85b23 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -21,175 +21,6 @@ Description A horizontal scrollbar, typically used to navigate through content that extends beyond the visible width of a control. It is a :ref:`Range`-based control and goes from left (min) to right (max). -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`scroll` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`scroll_focus` | - +-----------------------------------+-----------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HScrollBar_theme_icon_decrement: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement** - -Icon used as a button to scroll the :ref:`ScrollBar` left. Supports custom step using the :ref:`ScrollBar.custom_step` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_icon_decrement_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement_highlight** - -Displayed when the mouse cursor hovers over the decrement button. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_icon_decrement_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement_pressed** - -Displayed when the decrement button is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_icon_increment: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment** - -Icon used as a button to scroll the :ref:`ScrollBar` right. Supports custom step using the :ref:`ScrollBar.custom_step` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_icon_increment_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment_highlight** - -Displayed when the mouse cursor hovers over the increment button. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_icon_increment_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment_pressed** - -Displayed when the increment button is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_style_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber** - -Used as texture for the grabber, the draggable element representing current scroll. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_style_grabber_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_highlight** - -Used when the mouse hovers over the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_style_grabber_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_pressed** - -Used when the grabber is being dragged. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_style_scroll: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **scroll** - -Used as background of this :ref:`ScrollBar`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HScrollBar_theme_style_scroll_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **scroll_focus** - -Used as background when the :ref:`ScrollBar` has the GUI focus. - .. |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_hseparator.rst b/classes/class_hseparator.rst index e578d6f9248..883c63ad5f0 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -21,49 +21,6 @@ Description A horizontal separator used for separating other controls that are arranged **vertically**. **HSeparator** is purely visual and normally drawn as a :ref:`StyleBoxLine`. -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +---------------------------------+---------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`separation` | ``4`` | - +---------------------------------+---------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`separator` | | - +---------------------------------+---------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HSeparator_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``4`` - -The height of the area covered by the separator. Effectively works like a minimum height. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSeparator_theme_style_separator: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **separator** - -The style for the separator line. Works best with :ref:`StyleBoxLine`. - .. |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_hslider.rst b/classes/class_hslider.rst index 041e05d064d..82c2e03f8d9 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -21,147 +21,6 @@ Description A horizontal slider, used to adjust a value by moving a grabber along a horizontal axis. It is a :ref:`Range`-based control and goes from left (min) to right (max). -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`center_grabber` | ``0`` | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`grabber_offset` | ``0`` | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber_disabled` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber_highlight` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`tick` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`grabber_area` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`grabber_area_highlight` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`slider` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HSlider_theme_constant_center_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`int` **center_grabber** = ``0`` - -Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_constant_grabber_offset: - -.. rst-class:: classref-themeproperty - -:ref:`int` **grabber_offset** = ``0`` - -Vertical offset of the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_icon_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber** - -The texture for the grabber (the draggable element). - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_icon_grabber_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber_disabled** - -The texture for the grabber when it's disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_icon_grabber_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber_highlight** - -The texture for the grabber when it's focused. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_icon_tick: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **tick** - -The texture for the ticks, visible when :ref:`Slider.tick_count` is greater than 0. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_style_grabber_area: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_area** - -The background of the area to the left of the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_style_grabber_area_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_area_highlight** - -The background of the area to the left of the grabber that displays when it's being hovered or focused. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSlider_theme_style_slider: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **slider** - -The background for the whole slider. Determines the height of the ``grabber_area``. - .. |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_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index ee83a862493..bc00d1045fe 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -28,77 +28,6 @@ Tutorials - :doc:`Using Containers <../tutorials/ui/gui_containers>` -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`autohide` | ``1`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`separation` | ``12`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`Texture2D` | :ref:`grabber` | | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_HSplitContainer_theme_constant_autohide: - -.. rst-class:: classref-themeproperty - -:ref:`int` **autohide** = ``1`` - -Boolean value. If 1 (``true``), the grabber will hide automatically when it isn't under the cursor. If 0 (``false``), it's always visible. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSplitContainer_theme_constant_minimum_grab_thickness: - -.. rst-class:: classref-themeproperty - -:ref:`int` **minimum_grab_thickness** = ``6`` - -The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSplitContainer_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``12`` - -The space between sides of the container. - -.. rst-class:: classref-item-separator - ----- - -.. _class_HSplitContainer_theme_icon_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber** - -The icon used for the grabber drawn in the middle area. - .. |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_image.rst b/classes/class_image.rst index acefb74ca04..6c4fcb5f62f 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -313,7 +313,7 @@ OpenGL texture format ``GL_RGBA32F`` where there are four components, each a 32- :ref:`Format` **FORMAT_RH** = ``12`` -OpenGL texture format ``GL_R32F`` where there's one component, a 16-bit "half-precision" floating-point value. +OpenGL texture format ``GL_R16F`` where there's one component, a 16-bit "half-precision" floating-point value. .. _class_Image_constant_FORMAT_RGH: @@ -321,7 +321,7 @@ OpenGL texture format ``GL_R32F`` where there's one component, a 16-bit "half-pr :ref:`Format` **FORMAT_RGH** = ``13`` -OpenGL texture format ``GL_RG32F`` where there are two components, each a 16-bit "half-precision" floating-point value. +OpenGL texture format ``GL_RG16F`` where there are two components, each a 16-bit "half-precision" floating-point value. .. _class_Image_constant_FORMAT_RGBH: @@ -329,7 +329,7 @@ OpenGL texture format ``GL_RG32F`` where there are two components, each a 16-bit :ref:`Format` **FORMAT_RGBH** = ``14`` -OpenGL texture format ``GL_RGB32F`` where there are three components, each a 16-bit "half-precision" floating-point value. +OpenGL texture format ``GL_RGB16F`` where there are three components, each a 16-bit "half-precision" floating-point value. .. _class_Image_constant_FORMAT_RGBAH: @@ -337,7 +337,7 @@ OpenGL texture format ``GL_RGB32F`` where there are three components, each a 16- :ref:`Format` **FORMAT_RGBAH** = ``15`` -OpenGL texture format ``GL_RGBA32F`` where there are four components, each a 16-bit "half-precision" floating-point value. +OpenGL texture format ``GL_RGBA16F`` where there are four components, each a 16-bit "half-precision" floating-point value. .. _class_Image_constant_FORMAT_RGBE9995: diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index 805b639bf69..b9bfc1d0be5 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -24,13 +24,27 @@ Properties .. table:: :widths: auto - +-----------------------------------------+---------------------------------------------------------------------------+------------------+ - | :ref:`ImporterMesh` | :ref:`mesh` | | - +-----------------------------------------+---------------------------------------------------------------------------+------------------+ - | :ref:`NodePath` | :ref:`skeleton_path` | ``NodePath("")`` | - +-----------------------------------------+---------------------------------------------------------------------------+------------------+ - | :ref:`Skin` | :ref:`skin` | | - +-----------------------------------------+---------------------------------------------------------------------------+------------------+ + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | ``1`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`int` | :ref:`layer_mask` | ``1`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`ImporterMesh` | :ref:`mesh` | | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`NodePath` | :ref:`skeleton_path` | ``NodePath("")`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`Skin` | :ref:`skin` | | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`visibility_range_begin` | ``0.0`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`visibility_range_begin_margin` | ``0.0`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`visibility_range_end` | ``0.0`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`visibility_range_end_margin` | ``0.0`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`VisibilityRangeFadeMode` | :ref:`visibility_range_fade_mode` | ``0`` | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+------------------+ .. rst-class:: classref-section-separator @@ -41,6 +55,44 @@ Properties Property Descriptions --------------------- +.. _class_ImporterMeshInstance3D_property_cast_shadow: + +.. rst-class:: classref-property + +:ref:`ShadowCastingSetting` **cast_shadow** = ``1`` + +.. rst-class:: classref-property-setget + +- void **set_cast_shadows_setting** **(** :ref:`ShadowCastingSetting` value **)** +- :ref:`ShadowCastingSetting` **get_cast_shadows_setting** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_layer_mask: + +.. rst-class:: classref-property + +:ref:`int` **layer_mask** = ``1`` + +.. rst-class:: classref-property-setget + +- void **set_layer_mask** **(** :ref:`int` value **)** +- :ref:`int` **get_layer_mask** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_ImporterMeshInstance3D_property_mesh: .. rst-class:: classref-property @@ -90,6 +142,101 @@ Property Descriptions - void **set_skin** **(** :ref:`Skin` value **)** - :ref:`Skin` **get_skin** **(** **)** +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_visibility_range_begin: + +.. rst-class:: classref-property + +:ref:`float` **visibility_range_begin** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_visibility_range_begin** **(** :ref:`float` value **)** +- :ref:`float` **get_visibility_range_begin** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_visibility_range_begin_margin: + +.. rst-class:: classref-property + +:ref:`float` **visibility_range_begin_margin** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_visibility_range_begin_margin** **(** :ref:`float` value **)** +- :ref:`float` **get_visibility_range_begin_margin** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_visibility_range_end: + +.. rst-class:: classref-property + +:ref:`float` **visibility_range_end** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_visibility_range_end** **(** :ref:`float` value **)** +- :ref:`float` **get_visibility_range_end** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_visibility_range_end_margin: + +.. rst-class:: classref-property + +:ref:`float` **visibility_range_end_margin** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_visibility_range_end_margin** **(** :ref:`float` value **)** +- :ref:`float` **get_visibility_range_end_margin** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ImporterMeshInstance3D_property_visibility_range_fade_mode: + +.. rst-class:: classref-property + +:ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_visibility_range_fade_mode** **(** :ref:`VisibilityRangeFadeMode` value **)** +- :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode** **(** **)** + .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index e34064d2275..5a37823cf3a 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -53,6 +53,8 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`CameraAttributes` | :ref:`camera_attributes` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`denoiser_strength` | ``0.1`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`directional` | ``false`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`Color` | :ref:`environment_custom_color` | | @@ -367,6 +369,23 @@ The :ref:`CameraAttributes` resource that specifies expo ---- +.. _class_LightmapGI_property_denoiser_strength: + +.. rst-class:: classref-property + +:ref:`float` **denoiser_strength** = ``0.1`` + +.. rst-class:: classref-property-setget + +- void **set_denoiser_strength** **(** :ref:`float` value **)** +- :ref:`float` **get_denoiser_strength** **(** **)** + +The strength of denoising step applied to the generated lightmaps. Only effective if :ref:`use_denoiser` is ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_LightmapGI_property_directional: .. rst-class:: classref-property @@ -556,9 +575,7 @@ To further speed up bake times, decrease :ref:`bounces` value **)** - :ref:`bool` **is_using_denoiser** **(** **)** -If ``true``, uses a CPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image. - -\ **Note:** The built-in denoiser (OpenImageDenoise) may crash when denoising lightmaps in large scenes. If you encounter a crash at the end of lightmap baking, try disabling :ref:`use_denoiser`. +If ``true``, uses a GPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image. .. |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_linkbutton.rst b/classes/class_linkbutton.rst index d35643caef0..22281537ac3 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -59,27 +59,31 @@ Theme Properties .. table:: :widths: auto - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`underline_spacing` | ``2`` | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Font` | :ref:`font` | | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0, 0, 0, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(0, 0, 0, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`underline_spacing` | ``2`` | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Font` | :ref:`font` | | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`font_size` | | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +---------------------------------+----------------------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -284,6 +288,18 @@ Default text :ref:`Color` of the **LinkButton**. ---- +.. _class_LinkButton_theme_color_font_disabled_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_disabled_color** = ``Color(0, 0, 0, 1)`` + +Text :ref:`Color` used when the **LinkButton** is disabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_LinkButton_theme_color_font_focus_color: .. rst-class:: classref-themeproperty @@ -308,6 +324,18 @@ Text :ref:`Color` used when the **LinkButton** is being hovered. ---- +.. _class_LinkButton_theme_color_font_hover_pressed_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hover_pressed_color** = ``Color(0, 0, 0, 1)`` + +Text :ref:`Color` used when the **LinkButton** is being hovered and pressed. + +.. rst-class:: classref-item-separator + +---- + .. _class_LinkButton_theme_color_font_outline_color: .. rst-class:: classref-themeproperty diff --git a/classes/class_menubar.rst b/classes/class_menubar.rst index 70aed810531..5bdfdcc138b 100644 --- a/classes/class_menubar.rst +++ b/classes/class_menubar.rst @@ -110,14 +110,24 @@ Theme Properties +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`disabled` | | +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | + | :ref:`StyleBox` | :ref:`disabled_mirrored` | | +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`hover` | | +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_mirrored` | | + +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_pressed` | | + +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hover_pressed_mirrored` | | + +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`normal_mirrored` | | + +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`pressed` | | +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`pressed_mirrored` | | + +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+ .. rst-class:: classref-section-separator @@ -530,13 +540,13 @@ Font size of the menu item's text. ---- -.. _class_MenuBar_theme_style_focus: +.. _class_MenuBar_theme_style_disabled_mirrored: .. rst-class:: classref-themeproperty -:ref:`StyleBox` **focus** +:ref:`StyleBox` **disabled_mirrored** -:ref:`StyleBox` used when the menu item is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. +:ref:`StyleBox` used when the menu item is disabled (for right-to-left layouts). .. rst-class:: classref-item-separator @@ -554,6 +564,42 @@ Font size of the menu item's text. ---- +.. _class_MenuBar_theme_style_hover_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_mirrored** + +:ref:`StyleBox` used when the menu item is being hovered (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + +.. _class_MenuBar_theme_style_hover_pressed: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_pressed** + +:ref:`StyleBox` used when the menu item is being pressed and hovered at the same time. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MenuBar_theme_style_hover_pressed_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hover_pressed_mirrored** + +:ref:`StyleBox` used when the menu item is being pressed and hovered at the same time (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + .. _class_MenuBar_theme_style_normal: .. rst-class:: classref-themeproperty @@ -566,6 +612,18 @@ Default :ref:`StyleBox` for the menu item. ---- +.. _class_MenuBar_theme_style_normal_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **normal_mirrored** + +Default :ref:`StyleBox` for the menu item (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + .. _class_MenuBar_theme_style_pressed: .. rst-class:: classref-themeproperty @@ -574,6 +632,18 @@ Default :ref:`StyleBox` for the menu item. :ref:`StyleBox` used when the menu item is being pressed. +.. rst-class:: classref-item-separator + +---- + +.. _class_MenuBar_theme_style_pressed_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **pressed_mirrored** + +:ref:`StyleBox` used when the menu item is being pressed (for right-to-left layouts). + .. |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_menubutton.rst b/classes/class_menubutton.rst index f0dbd7069e9..e1f106a7f56 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -61,46 +61,6 @@ Methods | void | :ref:`show_popup` **(** **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(1, 1, 1, 0.3)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Font` | :ref:`font` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ - .. rst-class:: classref-section-separator ---- @@ -200,193 +160,6 @@ void **show_popup** **(** **)** Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_MenuButton_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -Default text :ref:`Color` of the **MenuButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_color_font_disabled_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_disabled_color** = ``Color(1, 1, 1, 0.3)`` - -Text :ref:`Color` used when the **MenuButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_color_font_focus_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -Text :ref:`Color` used when the **MenuButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_color_font_hover_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -Text :ref:`Color` used when the **MenuButton** is being hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **MenuButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_color_font_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` - -Text :ref:`Color` used when the **MenuButton** is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The horizontal space between **MenuButton**'s icon and text. Negative values will be treated as ``0`` when used. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -:ref:`Font` of the **MenuButton**'s text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Font size of the **MenuButton**'s text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_style_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled** - -:ref:`StyleBox` used when the **MenuButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -:ref:`StyleBox` used when the **MenuButton** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_style_hover: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover** - -:ref:`StyleBox` used when the **MenuButton** is being hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -Default :ref:`StyleBox` for the **MenuButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_MenuButton_theme_style_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed** - -:ref:`StyleBox` used when the **MenuButton** is being pressed. - .. |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_navigationmeshsourcegeometrydata2d.rst b/classes/class_navigationmeshsourcegeometrydata2d.rst new file mode 100644 index 00000000000..ea0e2c246e5 --- /dev/null +++ b/classes/class_navigationmeshsourcegeometrydata2d.rst @@ -0,0 +1,157 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshSourceGeometryData2D.xml. + +.. _class_NavigationMeshSourceGeometryData2D: + +NavigationMeshSourceGeometryData2D +================================== + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Container for parsed source geometry data used in navigation mesh baking. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Container for parsed source geometry data used in navigation mesh baking. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_obstruction_outline` **(** :ref:`PackedVector2Array` shape_outline **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_traversable_outline` **(** :ref:`PackedVector2Array` shape_outline **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`clear` **(** **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array[]` | :ref:`get_obstruction_outlines` **(** **)** |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array[]` | :ref:`get_traversable_outlines` **(** **)** |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_data` **(** **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_obstruction_outlines` **(** :ref:`PackedVector2Array[]` obstruction_outlines **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_traversable_outlines` **(** :ref:`PackedVector2Array[]` traversable_outlines **)** | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_NavigationMeshSourceGeometryData2D_method_add_obstruction_outline: + +.. rst-class:: classref-method + +void **add_obstruction_outline** **(** :ref:`PackedVector2Array` shape_outline **)** + +Adds the outline points of a shape as obstructed area. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_add_traversable_outline: + +.. rst-class:: classref-method + +void **add_traversable_outline** **(** :ref:`PackedVector2Array` shape_outline **)** + +Adds the outline points of a shape as traversable area. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_clear: + +.. rst-class:: classref-method + +void **clear** **(** **)** + +Clears the internal data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_get_obstruction_outlines: + +.. rst-class:: classref-method + +:ref:`PackedVector2Array[]` **get_obstruction_outlines** **(** **)** |const| + +Returns all the obstructed area outlines arrays. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_get_traversable_outlines: + +.. rst-class:: classref-method + +:ref:`PackedVector2Array[]` **get_traversable_outlines** **(** **)** |const| + +Returns all the traversable area outlines arrays. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_has_data: + +.. rst-class:: classref-method + +:ref:`bool` **has_data** **(** **)** + +Returns ``true`` when parsed source geometry data exists. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_set_obstruction_outlines: + +.. rst-class:: classref-method + +void **set_obstruction_outlines** **(** :ref:`PackedVector2Array[]` obstruction_outlines **)** + +Sets all the obstructed area outlines arrays. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_set_traversable_outlines: + +.. rst-class:: classref-method + +void **set_traversable_outlines** **(** :ref:`PackedVector2Array[]` traversable_outlines **)** + +Sets all the traversable area outlines arrays. + +.. |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.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 9d2cb630cc6..ccf7cce51b2 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -12,60 +12,60 @@ NavigationPolygon **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A navigation polygon that defines traversable areas and obstacles. +A 2D navigation mesh that describes a traversable surface for pathfinding. .. rst-class:: classref-introduction-group Description ----------- -There are two ways to create polygons. Either by using the :ref:`add_outline` method, or using the :ref:`add_polygon` method. +A navigation mesh can be created either by baking it with the help of the :ref:`NavigationServer2D`, or by adding vertices and convex polygon indices arrays manually. -Using :ref:`add_outline`: +To bake a navigation mesh at least one outline needs to be added that defines the outer bounds of the baked area. .. tabs:: .. code-tab:: gdscript - var polygon = NavigationPolygon.new() - var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) - polygon.add_outline(outline) - polygon.make_polygons_from_outlines() - $NavigationRegion2D.navigation_polygon = polygon + var new_navigation_mesh = NavigationPolygon.new() + var bounding_outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + new_navigation_mesh.add_outline(bounding_outline) + NavigationServer2D.bake_from_source_geometry_data(new_navigation_mesh, NavigationMeshSourceGeometryData2D.new()); + $NavigationRegion2D.navigation_polygon = new_navigation_mesh .. code-tab:: csharp - var polygon = new NavigationPolygon(); - var outline = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; - polygon.AddOutline(outline); - polygon.MakePolygonsFromOutlines(); - GetNode("NavigationRegion2D").NavigationPolygon = polygon; + var newNavigationMesh = new NavigationPolygon(); + var boundingOutline = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; + newNavigationMesh.AddOutline(boundingOutline); + NavigationServer2D.BakeFromSourceGeometryData(newNavigationMesh, new NavigationMeshSourceGeometryData2D()); + GetNode("NavigationRegion2D").NavigationPolygon = newNavigationMesh; -Using :ref:`add_polygon` and indices of the vertices array. +Adding vertices and polygon indices manually. .. tabs:: .. code-tab:: gdscript - var polygon = NavigationPolygon.new() - var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) - polygon.vertices = vertices - var indices = PackedInt32Array([0, 1, 2, 3]) - polygon.add_polygon(indices) - $NavigationRegion2D.navigation_polygon = polygon + var new_navigation_mesh = NavigationPolygon.new() + var new_vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + new_navigation_mesh.vertices = new_vertices + var new_polygon_indices = PackedInt32Array([0, 1, 2, 3]) + new_navigation_mesh.add_polygon(new_polygon_indices) + $NavigationRegion2D.navigation_polygon = new_navigation_mesh .. code-tab:: csharp - var polygon = new NavigationPolygon(); - var vertices = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; - polygon.Vertices = vertices; - var indices = new int[] { 0, 1, 2, 3 }; - polygon.AddPolygon(indices); - GetNode("NavigationRegion2D").NavigationPolygon = polygon; + var newNavigationMesh = new NavigationPolygon(); + var newVertices = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; + newNavigationMesh.Vertices = newVertices; + var newPolygonIndices = new int[] { 0, 1, 2, 3 }; + newNavigationMesh.AddPolygon(newPolygonIndices); + GetNode("NavigationRegion2D").NavigationPolygon = newNavigationMesh; @@ -86,9 +86,19 @@ Properties .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`cell_size` | ``1.0`` | - +---------------------------+--------------------------------------------------------------+---------+ + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`float` | :ref:`agent_radius` | ``10.0`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`float` | :ref:`cell_size` | ``1.0`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`int` | :ref:`parsed_collision_mask` | ``4294967295`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`ParsedGeometryType` | :ref:`parsed_geometry_type` | ``2`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`StringName` | :ref:`source_geometry_group_name` | ``&"navigation_polygon_source_geometry_group"`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ + | :ref:`SourceGeometryMode` | :ref:`source_geometry_mode` | ``0`` | + +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -117,6 +127,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_outline_count` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_parsed_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | @@ -129,6 +141,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_parsed_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_vertices` **(** :ref:`PackedVector2Array` vertices **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -138,9 +152,117 @@ Methods .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_NavigationPolygon_ParsedGeometryType: + +.. rst-class:: classref-enumeration + +enum **ParsedGeometryType**: + +.. _class_NavigationPolygon_constant_PARSED_GEOMETRY_MESH_INSTANCES: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParsedGeometryType` **PARSED_GEOMETRY_MESH_INSTANCES** = ``0`` + +Parses mesh instances as obstruction geometry. This includes :ref:`Polygon2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, and :ref:`TileMap` nodes. + +Meshes are only parsed when they use a 2D vertices surface format. + +.. _class_NavigationPolygon_constant_PARSED_GEOMETRY_STATIC_COLLIDERS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParsedGeometryType` **PARSED_GEOMETRY_STATIC_COLLIDERS** = ``1`` + +Parses :ref:`StaticBody2D` and :ref:`TileMap` colliders as obstruction geometry. The collider should be in any of the layers specified by :ref:`parsed_collision_mask`. + +.. _class_NavigationPolygon_constant_PARSED_GEOMETRY_BOTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParsedGeometryType` **PARSED_GEOMETRY_BOTH** = ``2`` + +Both :ref:`PARSED_GEOMETRY_MESH_INSTANCES` and :ref:`PARSED_GEOMETRY_STATIC_COLLIDERS`. + +.. _class_NavigationPolygon_constant_PARSED_GEOMETRY_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParsedGeometryType` **PARSED_GEOMETRY_MAX** = ``3`` + +Represents the size of the :ref:`ParsedGeometryType` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_NavigationPolygon_SourceGeometryMode: + +.. rst-class:: classref-enumeration + +enum **SourceGeometryMode**: + +.. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_ROOT_NODE_CHILDREN: + +.. rst-class:: classref-enumeration-constant + +:ref:`SourceGeometryMode` **SOURCE_GEOMETRY_ROOT_NODE_CHILDREN** = ``0`` + +Scans the child nodes of the root node recursively for geometry. + +.. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN: + +.. rst-class:: classref-enumeration-constant + +:ref:`SourceGeometryMode` **SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN** = ``1`` + +Scans nodes in a group and their child nodes recursively for geometry. The group is specified by :ref:`source_geometry_group_name`. + +.. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_GROUPS_EXPLICIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`SourceGeometryMode` **SOURCE_GEOMETRY_GROUPS_EXPLICIT** = ``2`` + +Uses nodes in a group for geometry. The group is specified by :ref:`source_geometry_group_name`. + +.. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`SourceGeometryMode` **SOURCE_GEOMETRY_MAX** = ``3`` + +Represents the size of the :ref:`SourceGeometryMode` enum. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- +.. _class_NavigationPolygon_property_agent_radius: + +.. rst-class:: classref-property + +:ref:`float` **agent_radius** = ``10.0`` + +.. rst-class:: classref-property-setget + +- void **set_agent_radius** **(** :ref:`float` value **)** +- :ref:`float` **get_agent_radius** **(** **)** + +The distance to erode/shrink the walkable surface when baking the navigation mesh. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPolygon_property_cell_size: .. rst-class:: classref-property @@ -154,6 +276,78 @@ Property Descriptions The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map. +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPolygon_property_parsed_collision_mask: + +.. rst-class:: classref-property + +:ref:`int` **parsed_collision_mask** = ``4294967295`` + +.. rst-class:: classref-property-setget + +- void **set_parsed_collision_mask** **(** :ref:`int` value **)** +- :ref:`int` **get_parsed_collision_mask** **(** **)** + +The physics layers to scan for static colliders. + +Only used when :ref:`parsed_geometry_type` is :ref:`PARSED_GEOMETRY_STATIC_COLLIDERS` or :ref:`PARSED_GEOMETRY_BOTH`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPolygon_property_parsed_geometry_type: + +.. rst-class:: classref-property + +:ref:`ParsedGeometryType` **parsed_geometry_type** = ``2`` + +.. rst-class:: classref-property-setget + +- void **set_parsed_geometry_type** **(** :ref:`ParsedGeometryType` value **)** +- :ref:`ParsedGeometryType` **get_parsed_geometry_type** **(** **)** + +Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeometryType` for possible values. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPolygon_property_source_geometry_group_name: + +.. rst-class:: classref-property + +:ref:`StringName` **source_geometry_group_name** = ``&"navigation_polygon_source_geometry_group"`` + +.. rst-class:: classref-property-setget + +- void **set_source_geometry_group_name** **(** :ref:`StringName` value **)** +- :ref:`StringName` **get_source_geometry_group_name** **(** **)** + +The group name of nodes that should be parsed for baking source geometry. + +Only used when :ref:`source_geometry_mode` is :ref:`SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN` or :ref:`SOURCE_GEOMETRY_GROUPS_EXPLICIT`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPolygon_property_source_geometry_mode: + +.. rst-class:: classref-property + +:ref:`SourceGeometryMode` **source_geometry_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_source_geometry_mode** **(** :ref:`SourceGeometryMode` value **)** +- :ref:`SourceGeometryMode` **get_source_geometry_mode** **(** **)** + +The source of the geometry used when baking. See :ref:`SourceGeometryMode` for possible values. + .. rst-class:: classref-section-separator ---- @@ -169,7 +363,7 @@ Method Descriptions void **add_outline** **(** :ref:`PackedVector2Array` outline **)** -Appends a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Appends a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. .. rst-class:: classref-item-separator @@ -181,7 +375,7 @@ Appends a :ref:`PackedVector2Array` that contains the void **add_outline_at_index** **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** -Adds a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Adds a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. .. rst-class:: classref-item-separator @@ -271,6 +465,18 @@ Returns the number of outlines that were created in the editor or by script. ---- +.. _class_NavigationPolygon_method_get_parsed_collision_mask_value: + +.. rst-class:: classref-method + +:ref:`bool` **get_parsed_collision_mask_value** **(** :ref:`int` layer_number **)** |const| + +Returns whether or not the specified layer of the :ref:`parsed_collision_mask` is enabled, given a ``layer_number`` between 1 and 32. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPolygon_method_get_polygon: .. rst-class:: classref-method @@ -315,6 +521,8 @@ void **make_polygons_from_outlines** **(** **)** Creates polygons from the outlines added in the editor or by script. +\ *Deprecated.* This function is deprecated, and might be removed in a future release. Use :ref:`NavigationServer2D.parse_source_geometry_data` and :ref:`NavigationServer2D.bake_from_source_geometry_data` instead. + .. rst-class:: classref-item-separator ---- @@ -343,6 +551,18 @@ Changes an outline created in the editor or by script. You have to call :ref:`ma ---- +.. _class_NavigationPolygon_method_set_parsed_collision_mask_value: + +.. rst-class:: classref-method + +void **set_parsed_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** + +Based on ``value``, enables or disables the specified layer in the :ref:`parsed_collision_mask`, given a ``layer_number`` between 1 and 32. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPolygon_method_set_vertices: .. rst-class:: classref-method diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index 07c20b39ae0..2e25df4bd71 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -74,6 +74,8 @@ Methods .. table:: :widths: auto + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`bake_navigation_polygon` **(** :ref:`bool` on_thread=true **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,6 +98,35 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_NavigationRegion2D_signal_bake_finished: + +.. rst-class:: classref-signal + +**bake_finished** **(** **)** + +Emitted when a navigation polygon bake operation is completed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationRegion2D_signal_navigation_polygon_changed: + +.. rst-class:: classref-signal + +**navigation_polygon_changed** **(** **)** + +Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- @@ -242,6 +273,18 @@ If enabled the navigation region will use edge connections to connect with other Method Descriptions ------------------- +.. _class_NavigationRegion2D_method_bake_navigation_polygon: + +.. rst-class:: classref-method + +void **bake_navigation_polygon** **(** :ref:`bool` on_thread=true **)** + +Bakes the :ref:`NavigationPolygon`. If ``on_thread`` is set to ``true`` (default), the baking is done on a separate thread. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationRegion2D_method_get_avoidance_layer_value: .. rst-class:: classref-method diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 40fbe9442c2..19efc01bb7a 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -52,201 +52,207 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_avoidance_enabled` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_paused` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_callback` **(** :ref:`RID` agent, :ref:`Callable` callback **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_enabled` **(** :ref:`RID` agent, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_layers` **(** :ref:`RID` agent, :ref:`int` layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_mask` **(** :ref:`RID` agent, :ref:`int` mask **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_priority` **(** :ref:`RID` agent, :ref:`float` priority **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_neighbor_distance` **(** :ref:`RID` agent, :ref:`float` distance **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_paused` **(** :ref:`RID` agent, :ref:`bool` paused **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_agents` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_obstacles` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity_forced` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_debug_enabled` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_get_enabled` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`link_get_end_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_owner_id` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`link_get_start_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enabled` **(** :ref:`RID` link, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_end_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_owner_id` **(** :ref:`RID` link, :ref:`int` owner_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_start_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_obstacles` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_get_use_edge_connections` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_use_edge_connections` **(** :ref:`RID` map, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_get_map` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_paused` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_enabled` **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_layers` **(** :ref:`RID` obstacle, :ref:`int` layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_map` **(** :ref:`RID` obstacle, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_paused` **(** :ref:`RID` obstacle, :ref:`bool` paused **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_position` **(** :ref:`RID` obstacle, :ref:`Vector2` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_radius` **(** :ref:`RID` obstacle, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_velocity` **(** :ref:`RID` obstacle, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_vertices` **(** :ref:`RID` obstacle, :ref:`PackedVector2Array` vertices **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`query_path` **(** :ref:`NavigationPathQueryParameters2D` parameters, :ref:`NavigationPathQueryResult2D` result **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_enabled` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_owner_id` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_use_edge_connections` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_owns_point` **(** :ref:`RID` region, :ref:`Vector2` point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enabled` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_polygon` **(** :ref:`RID` region, :ref:`NavigationPolygon` navigation_polygon **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_owner_id` **(** :ref:`RID` region, :ref:`int` owner_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_use_edge_connections` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_debug_enabled` **(** :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_create` **(** **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_avoidance_enabled` **(** :ref:`RID` agent **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_paused` **(** :ref:`RID` agent **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_avoidance_callback` **(** :ref:`RID` agent, :ref:`Callable` callback **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_avoidance_enabled` **(** :ref:`RID` agent, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_avoidance_layers` **(** :ref:`RID` agent, :ref:`int` layers **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_avoidance_mask` **(** :ref:`RID` agent, :ref:`int` mask **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_avoidance_priority` **(** :ref:`RID` agent, :ref:`float` priority **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_neighbor_distance` **(** :ref:`RID` agent, :ref:`float` distance **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_paused` **(** :ref:`RID` agent, :ref:`bool` paused **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_time_horizon_agents` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_time_horizon_obstacles` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`agent_set_velocity_forced` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`bake_from_source_geometry_data` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`bake_from_source_geometry_data_async` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_debug_enabled` **(** **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_create` **(** **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_get_enabled` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`link_get_end_position` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_owner_id` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`link_get_start_position` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_enabled` **(** :ref:`RID` link, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_end_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_owner_id` **(** :ref:`RID` link, :ref:`int` owner_id **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_start_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_create` **(** **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`map_get_obstacles` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_get_use_edge_connections` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` map **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`map_set_use_edge_connections` **(** :ref:`RID` map, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_create` **(** **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled` **(** :ref:`RID` obstacle **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_get_map` **(** :ref:`RID` obstacle **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_paused` **(** :ref:`RID` obstacle **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_avoidance_enabled` **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_avoidance_layers` **(** :ref:`RID` obstacle, :ref:`int` layers **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_map` **(** :ref:`RID` obstacle, :ref:`RID` map **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_paused` **(** :ref:`RID` obstacle, :ref:`bool` paused **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_position` **(** :ref:`RID` obstacle, :ref:`Vector2` position **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_radius` **(** :ref:`RID` obstacle, :ref:`float` radius **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_velocity` **(** :ref:`RID` obstacle, :ref:`Vector2` velocity **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`obstacle_set_vertices` **(** :ref:`RID` obstacle, :ref:`PackedVector2Array` vertices **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`parse_source_geometry_data` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`query_path` **(** :ref:`NavigationPathQueryParameters2D` parameters, :ref:`NavigationPathQueryResult2D` result **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_create` **(** **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_enabled` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_owner_id` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_use_edge_connections` **(** :ref:`RID` region **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_owns_point` **(** :ref:`RID` region, :ref:`Vector2` point **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_enabled` **(** :ref:`RID` region, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_navigation_polygon` **(** :ref:`RID` region, :ref:`NavigationPolygon` navigation_polygon **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_owner_id` **(** :ref:`RID` region, :ref:`int` owner_id **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`region_set_use_edge_connections` **(** :ref:`RID` region, :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_debug_enabled` **(** :ref:`bool` enabled **)** | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -542,6 +548,30 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo ---- +.. _class_NavigationServer2D_method_bake_from_source_geometry_data: + +.. rst-class:: classref-method + +void **bake_from_source_geometry_data** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** + +Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationServer2D_method_bake_from_source_geometry_data_async: + +.. rst-class:: classref-method + +void **bake_from_source_geometry_data_async** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** + +Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_free_rid: .. rst-class:: classref-method @@ -1184,6 +1214,22 @@ Sets the outline vertices for the obstacle. If the vertices are winded in clockw ---- +.. _class_NavigationServer2D_method_parse_source_geometry_data: + +.. rst-class:: classref-method + +void **parse_source_geometry_data** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** + +Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_polygon``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. + +\ **Note:** This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. + +\ **Performance:** While convenient, reading data arrays from :ref:`Mesh` resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the :ref:`RenderingServer` in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_query_path: .. rst-class:: classref-method diff --git a/classes/class_node.rst b/classes/class_node.rst index eda2a80882a..c5eb8cea5cf 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1033,6 +1033,8 @@ Add a custom description to a node. It will be displayed in a tooltip when hover The :ref:`MultiplayerAPI` instance associated with this node. See :ref:`SceneTree.get_multiplayer`. +\ **Note:** Renaming the node, or moving it in the tree, will not move the :ref:`MultiplayerAPI` to the new path, you will have to update this manually. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index 559e38bab39..6185b2a5aff 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -38,11 +38,15 @@ Properties .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`display_refresh_rate` | ``0.0`` | - +---------------------------+----------------------------------------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`render_target_size_multiplier` | ``1.0`` | - +---------------------------+----------------------------------------------------------------------------------------------------+---------+ + +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`display_refresh_rate` | ``0.0`` | + +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`foveation_dynamic` | ``false`` | + +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`foveation_level` | ``0`` | + +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`render_target_size_multiplier` | ``1.0`` | + +---------------------------+----------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -71,6 +75,8 @@ Methods +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_set_active` **(** :ref:`String` name **)** |const| | +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_foveation_supported` **(** **)** |const| | + +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_action_set_active` **(** :ref:`String` name, :ref:`bool` active **)** | +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_motion_range` **(** :ref:`Hand` hand, :ref:`HandMotionRange` motion_range **)** | @@ -466,6 +472,40 @@ The display refresh rate for the current HMD. Only functional if this feature is ---- +.. _class_OpenXRInterface_property_foveation_dynamic: + +.. rst-class:: classref-property + +:ref:`bool` **foveation_dynamic** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_foveation_dynamic** **(** :ref:`bool` value **)** +- :ref:`bool` **get_foveation_dynamic** **(** **)** + +Enable dynamic foveation adjustment, the interface must be initialised before this is accessible. If enabled foveation will automatically adjusted between low and :ref:`foveation_level`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_property_foveation_level: + +.. rst-class:: classref-property + +:ref:`int` **foveation_level** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_foveation_level** **(** :ref:`int` value **)** +- :ref:`int` **get_foveation_level** **(** **)** + +Set foveation level from 0 (off) to 3 (high), the interface must be initialised before this is accessible. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_property_render_target_size_multiplier: .. rst-class:: classref-property @@ -596,6 +636,20 @@ Returns ``true`` if the given action set is active. ---- +.. _class_OpenXRInterface_method_is_foveation_supported: + +.. rst-class:: classref-method + +:ref:`bool` **is_foveation_supported** **(** **)** |const| + +Returns ``true`` if OpenXRs foveation extension is supported, the interface must be initialised before this returns a valid value. + +\ **Note:** This feature is only available on the compatibility renderer and currently only available on some stand alone headsets. For Vulkan set :ref:`Viewport.vrs_mode` to ``VRS_XR`` on desktop. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_method_set_action_set_active: .. rst-class:: classref-method diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index ae4f0a6665e..c1b1fe2d4f1 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -123,53 +123,13 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`arrow_margin` | ``4`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`modulate_arrow` | ``0`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Font` | :ref:`font` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`Texture2D` | :ref:`arrow` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`disabled` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`disabled_mirrored` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`hover_mirrored` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`normal_mirrored` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`pressed` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ - | :ref:`StyleBox` | :ref:`pressed_mirrored` | | - +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`arrow_margin` | ``4`` | + +-----------------------------------+-------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`modulate_arrow` | ``0`` | + +-----------------------------------+-------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`arrow` | | + +-----------------------------------+-------------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator @@ -622,90 +582,6 @@ Adjusts popup position and sizing for the **OptionButton**, then shows the :ref: Theme Property Descriptions --------------------------- -.. _class_OptionButton_theme_color_font_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` - -Default text :ref:`Color` of the **OptionButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_disabled_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` - -Text :ref:`Color` used when the **OptionButton** is disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_focus_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -Text :ref:`Color` used when the **OptionButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_hover_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` - -Text :ref:`Color` used when the **OptionButton** is being hovered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_hover_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` - -Text :ref:`Color` used when the **OptionButton** is being hovered and pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_outline_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` - -The tint of text outline of the **OptionButton**. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_color_font_pressed_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` - -Text :ref:`Color` used when the **OptionButton** is being pressed. - -.. rst-class:: classref-item-separator - ----- - .. _class_OptionButton_theme_constant_arrow_margin: .. rst-class:: classref-themeproperty @@ -718,18 +594,6 @@ The horizontal space between the arrow icon and the right edge of the button. ---- -.. _class_OptionButton_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The horizontal space between **OptionButton**'s icon and text. Negative values will be treated as ``0`` when used. - -.. rst-class:: classref-item-separator - ----- - .. _class_OptionButton_theme_constant_modulate_arrow: .. rst-class:: classref-themeproperty @@ -742,44 +606,6 @@ If different than ``0``, the arrow icon will be modulated to the font color. ---- -.. _class_OptionButton_theme_constant_outline_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **outline_size** = ``0`` - -The size of the text outline. - -\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_font_font: - -.. rst-class:: classref-themeproperty - -:ref:`Font` **font** - -:ref:`Font` of the **OptionButton**'s text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_font_size_font_size: - -.. rst-class:: classref-themeproperty - -:ref:`int` **font_size** - -Font size of the **OptionButton**'s text. - -.. rst-class:: classref-item-separator - ----- - .. _class_OptionButton_theme_icon_arrow: .. rst-class:: classref-themeproperty @@ -788,114 +614,6 @@ Font size of the **OptionButton**'s text. The arrow icon to be drawn on the right end of the button. -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled** - -:ref:`StyleBox` used when the **OptionButton** is disabled (for left-to-right layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_disabled_mirrored: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **disabled_mirrored** - -:ref:`StyleBox` used when the **OptionButton** is disabled (for right-to-left layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **focus** - -:ref:`StyleBox` used when the **OptionButton** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_hover: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover** - -:ref:`StyleBox` used when the **OptionButton** is being hovered (for left-to-right layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_hover_mirrored: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **hover_mirrored** - -:ref:`StyleBox` used when the **OptionButton** is being hovered (for right-to-left layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_normal: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal** - -Default :ref:`StyleBox` for the **OptionButton** (for left-to-right layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_normal_mirrored: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **normal_mirrored** - -Default :ref:`StyleBox` for the **OptionButton** (for right-to-left layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed** - -:ref:`StyleBox` used when the **OptionButton** is being pressed (for left-to-right layouts). - -.. rst-class:: classref-item-separator - ----- - -.. _class_OptionButton_theme_style_pressed_mirrored: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **pressed_mirrored** - -:ref:`StyleBox` used when the **OptionButton** is being pressed (for right-to-left layouts). - .. |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_packedbytearray.rst b/classes/class_packedbytearray.rst index c2500d07a89..71b47974b66 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -677,7 +677,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`String` **get_string_from_ascii** **(** **)** |const| -Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. +Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. This is the inverse of :ref:`String.to_ascii_buffer`. .. rst-class:: classref-item-separator @@ -689,7 +689,7 @@ Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast altern :ref:`String` **get_string_from_utf8** **(** **)** |const| -Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. +Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of :ref:`String.to_utf8_buffer`. .. rst-class:: classref-item-separator @@ -701,7 +701,7 @@ Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`g :ref:`String` **get_string_from_utf16** **(** **)** |const| -Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. +Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of :ref:`String.to_utf16_buffer`. .. rst-class:: classref-item-separator @@ -713,7 +713,7 @@ Converts UTF-16 encoded array to :ref:`String`. If the BOM is miss :ref:`String` **get_string_from_utf32** **(** **)** |const| -Converts UTF-32 encoded array to :ref:`String`. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. +Converts UTF-32 encoded array to :ref:`String`. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. This is the inverse of :ref:`String.to_utf32_buffer`. .. rst-class:: classref-item-separator @@ -725,7 +725,7 @@ Converts UTF-32 encoded array to :ref:`String`. System endianness :ref:`String` **get_string_from_wchar** **(** **)** |const| -Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded array to :ref:`String`. Returns empty string if source array is not valid wide string. +Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded array to :ref:`String`. Returns empty string if source array is not valid wide string. This is the inverse of :ref:`String.to_wchar_buffer`. .. rst-class:: classref-item-separator diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 088b0a0ef29..f541200104a 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -246,8 +246,12 @@ Methods +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`pin_joint_get_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pin_joint_set_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | @@ -910,6 +914,56 @@ enum **PinJointParam**: Constant to set/get a how much the bond of the pin joint can flex. The default value of this parameter is ``0.0``. +.. _class_PhysicsServer2D_constant_PIN_JOINT_LIMIT_UPPER: + +.. rst-class:: classref-enumeration-constant + +:ref:`PinJointParam` **PIN_JOINT_LIMIT_UPPER** = ``1`` + +The maximum rotation around the pin. + +.. _class_PhysicsServer2D_constant_PIN_JOINT_LIMIT_LOWER: + +.. rst-class:: classref-enumeration-constant + +:ref:`PinJointParam` **PIN_JOINT_LIMIT_LOWER** = ``2`` + +The minimum rotation around the pin. + +.. _class_PhysicsServer2D_constant_PIN_JOINT_MOTOR_TARGET_VELOCITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`PinJointParam` **PIN_JOINT_MOTOR_TARGET_VELOCITY** = ``3`` + +Target speed for the motor. In radians per second. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_PhysicsServer2D_PinJointFlag: + +.. rst-class:: classref-enumeration + +enum **PinJointFlag**: + +.. _class_PhysicsServer2D_constant_PIN_JOINT_FLAG_ANGULAR_LIMIT_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`PinJointFlag` **PIN_JOINT_FLAG_ANGULAR_LIMIT_ENABLED** = ``0`` + +If ``true``, the pin has a maximum and a minimum rotation. + +.. _class_PhysicsServer2D_constant_PIN_JOINT_FLAG_MOTOR_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`PinJointFlag` **PIN_JOINT_FLAG_MOTOR_ENABLED** = ``1`` + +If ``true``, a motor turns the pin. + .. rst-class:: classref-item-separator ---- @@ -2317,6 +2371,18 @@ Sets the value of the given joint parameter. See :ref:`JointParam` **pin_joint_get_flag** **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |const| + +Gets a pin joint flag (see :ref:`PinJointFlag` constants). + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer2D_method_pin_joint_get_param: .. rst-class:: classref-method @@ -2329,6 +2395,18 @@ Returns the value of a pin joint parameter. See :ref:`PinJointParam` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** + +Sets a pin joint flag (see :ref:`PinJointFlag` constants). + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer2D_method_pin_joint_set_param: .. rst-class:: classref-method diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst index de46c4f1b4f..9966641ecba 100644 --- a/classes/class_physicsserver2dextension.rst +++ b/classes/class_physicsserver2dextension.rst @@ -256,8 +256,12 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_pin_joint_get_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |virtual| |const| | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_pin_joint_set_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** |virtual| | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_rectangle_shape_create` **(** **)** |virtual| | @@ -1886,6 +1890,20 @@ void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` **_pin_joint_get_flag** **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer2DExtension_method__pin_joint_get_param: .. rst-class:: classref-method @@ -1900,6 +1918,20 @@ void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** |virtual| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsServer2DExtension_method__pin_joint_set_param: .. rst-class:: classref-method diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 33406a916ab..fd07b8f4c57 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -29,9 +29,19 @@ Properties .. table:: :widths: auto - +---------------------------+-----------------------------------------------------+---------+ - | :ref:`float` | :ref:`softness` | ``0.0`` | - +---------------------------+-----------------------------------------------------+---------+ + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`angular_limit_enabled` | ``false`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`angular_limit_lower` | ``0.0`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`angular_limit_upper` | ``0.0`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`motor_enabled` | ``false`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`motor_target_velocity` | ``0.0`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`softness` | ``0.0`` | + +---------------------------+-------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -42,6 +52,91 @@ Properties Property Descriptions --------------------- +.. _class_PinJoint2D_property_angular_limit_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **angular_limit_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_angular_limit_enabled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_angular_limit_enabled** **(** **)** + +If ``true``, the pin maximum and minimum rotation, defined by :ref:`angular_limit_lower` and :ref:`angular_limit_upper` are applied. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PinJoint2D_property_angular_limit_lower: + +.. rst-class:: classref-property + +:ref:`float` **angular_limit_lower** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_angular_limit_lower** **(** :ref:`float` value **)** +- :ref:`float` **get_angular_limit_lower** **(** **)** + +The minimum rotation. Only active if :ref:`angular_limit_enabled` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PinJoint2D_property_angular_limit_upper: + +.. rst-class:: classref-property + +:ref:`float` **angular_limit_upper** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_angular_limit_upper** **(** :ref:`float` value **)** +- :ref:`float` **get_angular_limit_upper** **(** **)** + +The maximum rotation. Only active if :ref:`angular_limit_enabled` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PinJoint2D_property_motor_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **motor_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_motor_enabled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_motor_enabled** **(** **)** + +When activated, a motor turns the pin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PinJoint2D_property_motor_target_velocity: + +.. rst-class:: classref-property + +:ref:`float` **motor_target_velocity** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_motor_target_velocity** **(** :ref:`float` value **)** +- :ref:`float` **get_motor_target_velocity** **(** **)** + +Target speed for the motor. In radians per second. + +.. rst-class:: classref-item-separator + +---- + .. _class_PinJoint2D_property_softness: .. rst-class:: classref-property diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 3861192d018..3b567318ec5 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -45,6 +45,18 @@ Properties | :ref:`bool` | wrap_controls | ``true`` (overrides :ref:`Window`) | +-------------------------+---------------+-------------------------------------------------------------------------+ +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +---------------------------------+---------------------------------------------+ + | :ref:`StyleBox` | :ref:`panel` | + +---------------------------------+---------------------------------------------+ + .. rst-class:: classref-section-separator ---- @@ -62,6 +74,23 @@ Signals Emitted when the popup is hidden. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_Popup_theme_style_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel** + +Default :ref:`StyleBox` for the **Popup**. + .. |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_popupmenu.rst b/classes/class_popupmenu.rst index ad98b656008..e0aaf7c36c3 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -92,7 +92,7 @@ Methods +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | + | void | :ref:`clear` **(** :ref:`bool` free_submenus=false **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_focused_item` **(** **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -260,10 +260,6 @@ Theme Properties +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`labeled_separator_right` | | +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`panel` | | - +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`panel_disabled` | | - +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`separator` | | +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ @@ -684,9 +680,9 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -void **clear** **(** **)** +void **clear** **(** :ref:`bool` free_submenus=false **)** -Removes all items from the **PopupMenu**. +Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the submenu nodes are automatically freed. .. rst-class:: classref-item-separator @@ -1649,30 +1645,6 @@ Font size of the menu items. ---- -.. _class_PopupMenu_theme_style_panel: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **panel** - -Default :ref:`StyleBox` of the **PopupMenu** items. - -.. rst-class:: classref-item-separator - ----- - -.. _class_PopupMenu_theme_style_panel_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **panel_disabled** - -:ref:`StyleBox` used when the **PopupMenu** item is disabled. - -.. rst-class:: classref-item-separator - ----- - .. _class_PopupMenu_theme_style_separator: .. rst-class:: classref-themeproperty diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 1b8147deaa4..3e413c1a912 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -21,35 +21,6 @@ Description A popup with a configurable panel background. Any child controls added to this node will be stretched to fit the panel's size (similar to how :ref:`PanelContainer` works). If you are making windows, see :ref:`Window`. -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +---------------------------------+--------------------------------------------------+ - | :ref:`StyleBox` | :ref:`panel` | - +---------------------------------+--------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_PopupPanel_theme_style_panel: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **panel** - -The background panel style of this **PopupPanel**. - .. |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_progressbar.rst b/classes/class_progressbar.rst index 0ae4e9b1903..2af8e52114d 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -48,8 +48,6 @@ Theme Properties +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_shadow_color` | ``Color(0, 0, 0, 1)`` | - +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`Font` | :ref:`font` | | @@ -180,18 +178,6 @@ The tint of text outline of the **ProgressBar**. ---- -.. _class_ProgressBar_theme_color_font_shadow_color: - -.. rst-class:: classref-themeproperty - -:ref:`Color` **font_shadow_color** = ``Color(0, 0, 0, 1)`` - -The color of the text's shadow. - -.. rst-class:: classref-item-separator - ----- - .. _class_ProgressBar_theme_constant_outline_size: .. rst-class:: classref-themeproperty diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 3b08f8f2eda..2d00c8019f3 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -181,6 +181,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/inference_on_variant` | ``2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/gdscript/warnings/inferred_declaration` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/int_as_enum_without_cast` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/int_as_enum_without_match` | ``1`` | @@ -1521,6 +1523,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/form_factor` | ``"0"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`xr/openxr/foveation_dynamic` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`xr/openxr/foveation_level` | ``"0"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/reference_space` | ``"1"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/startup_alert` | ``true`` | @@ -2474,6 +2480,20 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w ---- +.. _class_ProjectSettings_property_debug/gdscript/warnings/inferred_declaration: + +.. rst-class:: classref-property + +:ref:`int` **debug/gdscript/warnings/inferred_declaration** = ``0`` + +When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. + +\ **Note:** This warning is recommended *in addition* to :ref:`debug/gdscript/warnings/untyped_declaration` if you want to always specify the type explicitly. Having ``INFERRED_DECLARATION`` warning level higher than ``UNTYPED_DECLARATION`` warning level makes little sense and is not recommended. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/int_as_enum_without_cast: .. rst-class:: classref-property @@ -11031,6 +11051,30 @@ Specify whether OpenXR should be configured for an HMD or a hand held device. ---- +.. _class_ProjectSettings_property_xr/openxr/foveation_dynamic: + +.. rst-class:: classref-property + +:ref:`bool` **xr/openxr/foveation_dynamic** = ``false`` + +If true and foveation is supported, will automatically adjust foveation level based on framerate up to the level set on ``xr/openxr/foveation_level``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_xr/openxr/foveation_level: + +.. rst-class:: classref-property + +:ref:`int` **xr/openxr/foveation_level** = ``"0"`` + +Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_xr/openxr/reference_space: .. rst-class:: classref-property diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index caef4c9438c..97c169fee92 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -203,6 +203,8 @@ Methods +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create` **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_create_from_extension` **(** :ref:`TextureType` type, :ref:`DataFormat` format, :ref:`TextureSamples` samples, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags, :ref:`int` image, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`int` layers **)** | + +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared_from_slice` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** | @@ -5406,6 +5408,18 @@ Once finished with your RID, you will want to free the RID using the RenderingDe ---- +.. _class_RenderingDevice_method_texture_create_from_extension: + +.. rst-class:: classref-method + +:ref:`RID` **texture_create_from_extension** **(** :ref:`TextureType` type, :ref:`DataFormat` format, :ref:`TextureSamples` samples, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags, :ref:`int` image, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`int` layers **)** + +Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, and ``layers``. This can be used to allow Godot to render onto foreign images. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingDevice_method_texture_create_shared: .. rst-class:: classref-method diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 725318c9088..512804d97d3 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -2702,11 +2702,19 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2: + +.. rst-class:: classref-enumeration-constant + +:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2`` + +Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. + .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``2`` +:ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``3`` Represents the size of the :ref:`ViewportScaling3DMode` enum. @@ -3346,6 +3354,14 @@ Draws the occlusion culling buffer. This low-resolution occlusion culling buffer Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay. +.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER: + +.. rst-class:: classref-enumeration-constant + +:ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26`` + +Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_renderscenebuffersrd.rst b/classes/class_renderscenebuffersrd.rst index 3fcad416308..6ed9bd560c6 100644 --- a/classes/class_renderscenebuffersrd.rst +++ b/classes/class_renderscenebuffersrd.rst @@ -64,6 +64,8 @@ Methods +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_texture_slice_size` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` mipmap **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_texture_slice_view` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps, :ref:`RDTextureView` view **)** | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_use_taa` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_velocity_layer` **(** :ref:`int` layer **)** | @@ -252,6 +254,18 @@ Returns the texture size of a given slice of a cached texture. ---- +.. _class_RenderSceneBuffersRD_method_get_texture_slice_view: + +.. rst-class:: classref-method + +:ref:`RID` **get_texture_slice_view** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps, :ref:`RDTextureView` view **)** + +Returns a specific view of a slice (layer or mipmap) for a cached texture. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderSceneBuffersRD_method_get_use_taa: .. rst-class:: classref-method diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 1b96740dadc..8703ce8ac57 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for serializable objects. @@ -63,6 +63,8 @@ Methods +---------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_get_rid` **(** **)** |virtual| | +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_setup_local_to_scene` **(** **)** |virtual| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** |const| | +---------------------------------+------------------------------------------------------------------------------------------------------------------+ | void | :ref:`emit_changed` **(** **)** | @@ -105,7 +107,9 @@ Emitted when the resource changes, usually when one of its properties is modifie **setup_local_to_scene_requested** **(** **)** -Emitted by the newly duplicated resource with :ref:`resource_local_to_scene` set to ``true``, when the scene is instantiated. Custom behavior can be defined by connecting this signal. +Emitted by a newly duplicated resource with :ref:`resource_local_to_scene` set to ``true``. + +\ *Deprecated.* This signal is only emitted when the resource is created. Override :ref:`_setup_local_to_scene` instead. .. rst-class:: classref-section-separator @@ -188,6 +192,29 @@ Override this method to return a custom :ref:`RID` when :ref:`get_rid ---- +.. _class_Resource_method__setup_local_to_scene: + +.. rst-class:: classref-method + +void **_setup_local_to_scene** **(** **)** |virtual| + +Override this method to customize the newly duplicated resource created from :ref:`PackedScene.instantiate`, if the original's :ref:`resource_local_to_scene` is set to ``true``. + +\ **Example:** Set a random ``damage`` value to every local resource from an instantiated scene. + +:: + + extends Resource + + var damage = 0 + + func _setup_local_to_scene(): + damage = randi_range(10, 40) + +.. rst-class:: classref-item-separator + +---- + .. _class_Resource_method_duplicate: .. rst-class:: classref-method @@ -258,9 +285,9 @@ Returns the :ref:`RID` of this resource (or an empty RID). Many resou void **setup_local_to_scene** **(** **)** -Emits the :ref:`setup_local_to_scene_requested` signal. If :ref:`resource_local_to_scene` is set to ``true``, this method is called from :ref:`PackedScene.instantiate` by the newly duplicated resource within the scene instance. +Calls :ref:`_setup_local_to_scene`. If :ref:`resource_local_to_scene` is set to ``true``, this method is automatically called from :ref:`PackedScene.instantiate` by the newly duplicated resource within the scene instance. -For most resources, this method performs no logic of its own. Custom behavior can be defined by connecting :ref:`setup_local_to_scene_requested` from a script, **not** by overriding this method. +\ *Deprecated.* This method should only be called internally. Override :ref:`_setup_local_to_scene` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 98a43c28b06..0dfe9670905 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -108,141 +108,143 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0) **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_text` **(** :ref:`String` text **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_text` **(** :ref:`String` bbcode **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_line` **(** :ref:`int` character **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_paragraph` **(** :ref:`int` character **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_height` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_width` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_offset` **(** :ref:`int` line **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_paragraph_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_paragraph_offset` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_parsed_text` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_paragraph_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_ready` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`menu_option` **(** :ref:`int` option **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`newline` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PackedStringArray` expressions **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop_all` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop_context` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bgcolor` **(** :ref:`Color` bgcolor **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bold` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bold_italics` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_cell` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_context` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_customfx` **(** :ref:`RichTextEffect` effect, :ref:`Dictionary` env **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_dropcap` **(** :ref:`String` string, :ref:`Font` font, :ref:`int` size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color` color=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_color=Color(0, 0, 0, 0) **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_fgcolor` **(** :ref:`Color` fgcolor **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_font` **(** :ref:`Font` font, :ref:`int` font_size=0 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_hint` **(** :ref:`String` description **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_indent` **(** :ref:`int` level **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_italics` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_language` **(** :ref:`String` language **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_meta` **(** :ref:`Variant` data **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_mono` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_normal` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_outline_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_outline_size` **(** :ref:`int` outline_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_paragraph` **(** :ref:`HorizontalAlignment` alignment, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=163, :ref:`PackedFloat32Array` tab_stops=PackedFloat32Array() **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_strikethrough` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_table` **(** :ref:`int` columns, :ref:`InlineAlignment` inline_align=0, :ref:`int` align_to_row=-1 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_underline` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`remove_paragraph` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_paragraph` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_selection` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_all` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_border_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_padding` **(** :ref:`Rect2` padding **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_row_background_color` **(** :ref:`Color` odd_row_bg, :ref:`Color` even_row_bg **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_size_override` **(** :ref:`Vector2` min_size, :ref:`Vector2` max_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Variant` key=null, :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_text` **(** :ref:`String` text **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`append_text` **(** :ref:`String` bbcode **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`clear` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`deselect` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_line` **(** :ref:`int` character **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_paragraph` **(** :ref:`int` character **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_height` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_width` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_offset` **(** :ref:`int` line **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_paragraph_count` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_paragraph_offset` **(** :ref:`int` paragraph **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_parsed_text` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_paragraph_count` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_ready` **(** **)** |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`menu_option` **(** :ref:`int` option **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`newline` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PackedStringArray` expressions **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pop` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pop_all` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pop_context` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_bgcolor` **(** :ref:`Color` bgcolor **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_bold` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_bold_italics` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_cell` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_color` **(** :ref:`Color` color **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_context` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_customfx` **(** :ref:`RichTextEffect` effect, :ref:`Dictionary` env **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_dropcap` **(** :ref:`String` string, :ref:`Font` font, :ref:`int` size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color` color=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_color=Color(0, 0, 0, 0) **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_fgcolor` **(** :ref:`Color` fgcolor **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_font` **(** :ref:`Font` font, :ref:`int` font_size=0 **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_hint` **(** :ref:`String` description **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_indent` **(** :ref:`int` level **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_italics` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_language` **(** :ref:`String` language **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_meta` **(** :ref:`Variant` data **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_mono` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_normal` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_outline_color` **(** :ref:`Color` color **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_outline_size` **(** :ref:`int` outline_size **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_paragraph` **(** :ref:`HorizontalAlignment` alignment, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=163, :ref:`PackedFloat32Array` tab_stops=PackedFloat32Array() **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_strikethrough` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_table` **(** :ref:`int` columns, :ref:`InlineAlignment` inline_align=0, :ref:`int` align_to_row=-1 **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_underline` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`remove_paragraph` **(** :ref:`int` paragraph **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`scroll_to_paragraph` **(** :ref:`int` paragraph **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`scroll_to_selection` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`select_all` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_cell_border_color` **(** :ref:`Color` color **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_cell_padding` **(** :ref:`Rect2` padding **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_cell_row_background_color` **(** :ref:`Color` odd_row_bg, :ref:`Color` even_row_bg **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_cell_size_override` **(** :ref:`Vector2` min_size, :ref:`Vector2` max_size **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`update_image` **(** :ref:`Variant` key, |bitfield|\<:ref:`ImageUpdateMask`\> mask, :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -446,6 +448,80 @@ Selects the whole **RichTextLabel** text. Represents the size of the :ref:`MenuItems` enum. +.. rst-class:: classref-item-separator + +---- + +.. _enum_RichTextLabel_ImageUpdateMask: + +.. rst-class:: classref-enumeration + +flags **ImageUpdateMask**: + +.. _class_RichTextLabel_constant_UPDATE_TEXTURE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_TEXTURE** = ``1`` + +If this bit is set, :ref:`update_image` changes image texture. + +.. _class_RichTextLabel_constant_UPDATE_SIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_SIZE** = ``2`` + +If this bit is set, :ref:`update_image` changes image size. + +.. _class_RichTextLabel_constant_UPDATE_COLOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_COLOR** = ``4`` + +If this bit is set, :ref:`update_image` changes image color. + +.. _class_RichTextLabel_constant_UPDATE_ALIGNMENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_ALIGNMENT** = ``8`` + +If this bit is set, :ref:`update_image` changes image inline alignment. + +.. _class_RichTextLabel_constant_UPDATE_REGION: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_REGION** = ``16`` + +If this bit is set, :ref:`update_image` changes image texture region. + +.. _class_RichTextLabel_constant_UPDATE_PAD: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_PAD** = ``32`` + +If this bit is set, :ref:`update_image` changes image padding. + +.. _class_RichTextLabel_constant_UPDATE_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_TOOLTIP** = ``64`` + +If this bit is set, :ref:`update_image` changes image tooltip. + +.. _class_RichTextLabel_constant_UPDATE_WIDTH_IN_PERCENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ImageUpdateMask` **UPDATE_WIDTH_IN_PERCENT** = ``128`` + +If this bit is set, :ref:`update_image` changes image width from/to percents. + .. rst-class:: classref-section-separator ---- @@ -882,7 +958,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_image** **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0) **)** +void **add_image** **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Variant` key=null, :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image, a ``color`` to tint the image and a ``region`` to only use parts of the image. @@ -890,6 +966,12 @@ If ``width`` or ``height`` is set to 0, the image size will be adjusted in order If ``width`` and ``height`` are not set, but ``region`` is, the region's rect will be used. +\ ``key`` is an optional identifier, that can be used to modify the image via :ref:`update_image`. + +If ``pad`` is set, and the image is smaller than the size specified by ``width`` and ``height``, the image padding is added to match the size instead of upscaling. + +If ``size_in_percent`` is set, ``width`` and ``height`` values are percentages of the control width instead of pixels. + .. rst-class:: classref-item-separator ---- @@ -1763,6 +1845,18 @@ For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width wou If ``expand`` is ``false``, the column will not contribute to the total ratio. +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_method_update_image: + +.. rst-class:: classref-method + +void **update_image** **(** :ref:`Variant` key, |bitfield|\<:ref:`ImageUpdateMask`\> mask, :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** + +Updates the existing images with the key ``key``. Only properties specified by ``mask`` bits are updated. See :ref:`add_image`. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 0a1b501c552..a98ec1c9c95 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -623,9 +623,7 @@ Returns the current frame number, i.e. the total frame count since the applicati :ref:`MultiplayerAPI` **get_multiplayer** **(** :ref:`NodePath` for_path=NodePath("") **)** |const| -Return the :ref:`MultiplayerAPI` configured for the given path, or the default one if ``for_path`` is empty. - -\ **Note:** Only one :ref:`MultiplayerAPI` may be configured for any subpath. If one is configured for ``"/root/Foo"`` then calling this for ``"/root/Foo/Bar"`` will return the one configured for ``"/root/Foo"``, regardless if one is configured for that path. +Searches for the :ref:`MultiplayerAPI` configured for the given path, if one does not exist it searches the parent paths until one is found. If the path is empty, or none is found, the default one is returned. See :ref:`set_multiplayer`. .. rst-class:: classref-item-separator @@ -789,7 +787,7 @@ void **set_multiplayer** **(** :ref:`MultiplayerAPI` multi Sets a custom :ref:`MultiplayerAPI` with the given ``root_path`` (controlling also the relative subpaths), or override the default one if ``root_path`` is empty. -\ **Note:** Only one :ref:`MultiplayerAPI` may be configured for any subpath. If one is configured for ``"/root/Foo"`` setting one for ``"/root/Foo/Bar"`` will be ignored. See :ref:`get_multiplayer`. +\ **Note:** No :ref:`MultiplayerAPI` must be configured for the subpath containing ``root_path``, nested custom multiplayers are not allowed. I.e. if one is configured for ``"/root/Foo"`` setting one for ``"/root/Foo/Bar"`` will cause an error. .. rst-class:: classref-item-separator diff --git a/classes/class_script.rst b/classes/class_script.rst index 86ed908e84d..bfb139f48cf 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -77,6 +77,8 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_abstract` **(** **)** |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tool` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | @@ -245,6 +247,18 @@ Returns ``true`` if ``base_object`` is an instance of this script. ---- +.. _class_Script_method_is_abstract: + +.. rst-class:: classref-method + +:ref:`bool` **is_abstract** **(** **)** |const| + +Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. + +.. rst-class:: classref-item-separator + +---- + .. _class_Script_method_is_tool: .. rst-class:: classref-method diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index 4c2a826c2bd..2c87b0cf630 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -75,6 +75,8 @@ Methods +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_instance_has` **(** :ref:`Object` object **)** |virtual| |const| | +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_abstract` **(** **)** |virtual| |const| | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled` **(** **)** |virtual| |const| | +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_tool` **(** **)** |virtual| |const| | @@ -451,6 +453,18 @@ void* **_instance_create** **(** :ref:`Object` for_object **)** |v ---- +.. _class_ScriptExtension_method__is_abstract: + +.. rst-class:: classref-method + +:ref:`bool` **_is_abstract** **(** **)** |virtual| |const| + +Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptExtension_method__is_placeholder_fallback_enabled: .. rst-class:: classref-method diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 4e948156ed1..eb527922118 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -832,9 +832,7 @@ void **_frame** **(** **)** |virtual| :ref:`bool` **_has_named_classes** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +*Deprecated.* This method is not called by the engine. .. rst-class:: classref-item-separator diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index a21a383fc36..f6a7327bb66 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -37,6 +37,40 @@ Properties | :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`decrement` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`decrement_highlight` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`decrement_pressed` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`increment` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`increment_highlight` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`increment_pressed` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`grabber` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`grabber_highlight` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`grabber_pressed` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`hscroll` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`scroll` | + +-----------------------------------+----------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`scroll_focus` | + +-----------------------------------+----------------------------------------------------------------------------+ + .. rst-class:: classref-section-separator ---- @@ -76,6 +110,157 @@ Property Descriptions Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the **ScrollBar** is focused. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_ScrollBar_theme_icon_decrement: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **decrement** + +Icon used as a button to scroll the **ScrollBar** left/up. Supports custom step using the :ref:`custom_step` property. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_icon_decrement_highlight: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **decrement_highlight** + +Displayed when the mouse cursor hovers over the decrement button. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_icon_decrement_pressed: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **decrement_pressed** + +Displayed when the decrement button is being pressed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_icon_increment: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **increment** + +Icon used as a button to scroll the **ScrollBar** right/down. Supports custom step using the :ref:`custom_step` property. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_icon_increment_highlight: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **increment_highlight** + +Displayed when the mouse cursor hovers over the increment button. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_icon_increment_pressed: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **increment_pressed** + +Displayed when the increment button is being pressed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **grabber** + +Used as texture for the grabber, the draggable element representing current scroll. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_grabber_highlight: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **grabber_highlight** + +Used when the mouse hovers over the grabber. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_grabber_pressed: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **grabber_pressed** + +Used when the grabber is being dragged. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_hscroll: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hscroll** + +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_scroll: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **scroll** + +Used as background of this **ScrollBar**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollBar_theme_style_scroll_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **scroll_focus** + +Used as background when the **ScrollBar** has the GUI focus. + .. |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_separator.rst b/classes/class_separator.rst index e9e785349b5..ae73f68e7f0 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -23,6 +23,49 @@ Description Abstract base class for separators, used for separating other controls. **Separator**\ s are purely visual and normally drawn as a :ref:`StyleBoxLine`. +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +---------------------------------+--------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`separation` | ``0`` | + +---------------------------------+--------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`separator` | | + +---------------------------------+--------------------------------------------------------------+-------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_Separator_theme_constant_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **separation** = ``0`` + +The size of the area covered by the separator. Effectively works like a minimum width/height. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Separator_theme_style_separator: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **separator** + +The style for the separator line. Works best with :ref:`StyleBoxLine` (remember to enable :ref:`StyleBoxLine.vertical` for :ref:`VSeparator`). + .. |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_slider.rst b/classes/class_slider.rst index 1496f3bad8a..cc62a0687df 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -45,6 +45,34 @@ Properties | :ref:`bool` | :ref:`ticks_on_borders` | ``false`` | +------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`center_grabber` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`grabber_offset` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`grabber` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`grabber_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`grabber_highlight` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`tick` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`grabber_area` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`grabber_area_highlight` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`slider` | | + +-----------------------------------+--------------------------------------------------------------------------------+-------+ + .. rst-class:: classref-section-separator ---- @@ -147,6 +175,119 @@ Number of ticks displayed on the slider, including border ticks. Ticks are unifo If ``true``, the slider will display ticks for minimum and maximum values. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_Slider_theme_constant_center_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`int` **center_grabber** = ``0`` + +Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_constant_grabber_offset: + +.. rst-class:: classref-themeproperty + +:ref:`int` **grabber_offset** = ``0`` + +Vertical/horizontal offset of the grabber. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_icon_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **grabber** + +The texture for the grabber (the draggable element). + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_icon_grabber_disabled: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **grabber_disabled** + +The texture for the grabber when it's disabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_icon_grabber_highlight: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **grabber_highlight** + +The texture for the grabber when it's focused. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_icon_tick: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **tick** + +The texture for the ticks, visible when :ref:`tick_count` is greater than 0. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_style_grabber_area: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **grabber_area** + +The background of the area to the left/bottom of the grabber. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_style_grabber_area_highlight: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **grabber_area_highlight** + +The background of the area to the left/bottom of the grabber that displays when it's being hovered or focused. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Slider_theme_style_slider: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **slider** + +The background for the whole slider. Determines the height/width of the ``grabber_area``. + .. |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_splitcontainer.rst b/classes/class_splitcontainer.rst index fda75fd3d4c..0c518983247 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -75,6 +75,8 @@ Theme Properties +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ | :ref:`int` | :ref:`separation` | ``12`` | +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ + | :ref:`Texture2D` | :ref:`grabber` | | + +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ | :ref:`Texture2D` | :ref:`h_grabber` | | +-----------------------------------+-------------------------------------------------------------------------------------------+--------+ | :ref:`Texture2D` | :ref:`v_grabber` | | @@ -273,6 +275,18 @@ The space between sides of the container. ---- +.. _class_SplitContainer_theme_icon_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **grabber** + +The icon used for the grabber drawn in the middle area. + +.. rst-class:: classref-item-separator + +---- + .. _class_SplitContainer_theme_icon_h_grabber: .. rst-class:: classref-themeproperty diff --git a/classes/class_string.rst b/classes/class_string.rst index 34af8e2fe98..15a10337844 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1770,7 +1770,7 @@ Returns part of the string from the position ``from`` with length ``len``. If `` :ref:`PackedByteArray` **to_ascii_buffer** **(** **)** |const| -Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. +Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. This is the inverse of :ref:`PackedByteArray.get_string_from_ascii`. .. rst-class:: classref-item-separator @@ -1881,7 +1881,7 @@ Returns the string converted to uppercase. :ref:`PackedByteArray` **to_utf8_buffer** **(** **)** |const| -Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. +Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. This is the inverse of :ref:`PackedByteArray.get_string_from_utf8`. .. rst-class:: classref-item-separator @@ -1893,7 +1893,7 @@ Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray` **to_utf16_buffer** **(** **)** |const| -Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. +Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf16`. .. rst-class:: classref-item-separator @@ -1905,7 +1905,7 @@ Converts the string to a `UTF-16 `__ encod :ref:`PackedByteArray` **to_utf32_buffer** **(** **)** |const| -Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. +Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf32`. .. rst-class:: classref-item-separator @@ -1917,7 +1917,7 @@ Converts the string to a `UTF-32 `__ encod :ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| -Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. +Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_wchar`. .. rst-class:: classref-item-separator diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index eb76fd31b26..ca8caa872f2 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -29,29 +29,31 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`clip_tabs` | ``true`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`current_tab` | ``0`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ``false`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`max_tab_width` | ``0`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`scroll_to_selected` | ``true`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`scrolling_enabled` | ``true`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`select_with_rmb` | ``false`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`AlignmentMode` | :ref:`tab_alignment` | ``0`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | ``0`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`tab_count` | ``0`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`tabs_rearrange_group` | ``-1`` | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clip_tabs` | ``true`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`current_tab` | ``0`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ``false`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_tab_width` | ``0`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_to_selected` | ``true`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scrolling_enabled` | ``true`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_with_rmb` | ``false`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`AlignmentMode` | :ref:`tab_alignment` | ``0`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | ``0`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`tab_count` | ``0`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`tabs_rearrange_group` | ``-1`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -100,6 +102,10 @@ Methods +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_next_available` **(** **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_previous_available` **(** **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_button_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | @@ -168,6 +174,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_disabled` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`tab_focus` | | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_hovered` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_selected` | | @@ -811,6 +819,30 @@ Removes the tab at index ``tab_idx``. ---- +.. _class_TabBar_method_select_next_available: + +.. rst-class:: classref-method + +:ref:`bool` **select_next_available** **(** **)** + +Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TabBar_method_select_previous_available: + +.. rst-class:: classref-method + +:ref:`bool` **select_previous_available** **(** **)** + +Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_method_set_tab_button_icon: .. rst-class:: classref-method @@ -1166,6 +1198,18 @@ The style of disabled tabs. ---- +.. _class_TabBar_theme_style_tab_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **tab_focus** + +:ref:`StyleBox` used when the **TabBar** is focused. The :ref:`tab_focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox` of the selected tab, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_style_tab_hovered: .. rst-class:: classref-themeproperty @@ -1174,6 +1218,8 @@ The style of disabled tabs. The style of the currently hovered tab. Does not apply to the selected tab. +\ **Note:** This style will be drawn with the same width as :ref:`tab_unselected` at minimum. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 99ad5e9f345..ce265e63f92 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -49,6 +49,8 @@ Properties +-------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`AlignmentMode` | :ref:`tab_alignment` | ``0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`FocusMode` | :ref:`tab_focus_mode` | ``2`` | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`tabs_rearrange_group` | ``-1`` | +-------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`tabs_visible` | ``true`` | @@ -71,6 +73,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TabBar` | :ref:`get_tab_bar` **(** **)** |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_tab_button_icon` **(** :ref:`int` tab_idx **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** |const| | @@ -91,6 +95,10 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tab_hidden` **(** :ref:`int` tab_idx **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_next_available` **(** **)** | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_previous_available` **(** **)** | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_button_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | @@ -157,6 +165,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_disabled` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`tab_focus` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_hovered` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_selected` | | @@ -349,6 +359,23 @@ Sets the position at which tabs will be placed. See :ref:`AlignmentMode` **tab_focus_mode** = ``2`` + +.. rst-class:: classref-property-setget + +- void **set_tab_focus_mode** **(** :ref:`FocusMode` value **)** +- :ref:`FocusMode` **get_tab_focus_mode** **(** **)** + +The focus access mode for the internal :ref:`TabBar` node. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_property_tabs_rearrange_group: .. rst-class:: classref-property @@ -445,6 +472,20 @@ Returns the previously active tab index. ---- +.. _class_TabContainer_method_get_tab_bar: + +.. rst-class:: classref-method + +:ref:`TabBar` **get_tab_bar** **(** **)** |const| + +Returns the :ref:`TabBar` contained in this container. + +\ **Warning:** This is a required internal node, removing and freeing it or editing its tabs may cause a crash. If you wish to edit the tabs, use the methods provided in **TabContainer**. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_get_tab_button_icon: .. rst-class:: classref-method @@ -565,6 +606,30 @@ Returns ``true`` if the tab at index ``tab_idx`` is hidden. ---- +.. _class_TabContainer_method_select_next_available: + +.. rst-class:: classref-method + +:ref:`bool` **select_next_available** **(** **)** + +Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TabContainer_method_select_previous_available: + +.. rst-class:: classref-method + +:ref:`bool` **select_previous_available** **(** **)** + +Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_set_popup: .. rst-class:: classref-method @@ -910,6 +975,18 @@ The style of disabled tabs. ---- +.. _class_TabContainer_theme_style_tab_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **tab_focus** + +:ref:`StyleBox` used when the :ref:`TabBar` is focused. The :ref:`tab_focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox` of the selected tab, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_style_tab_hovered: .. rst-class:: classref-themeproperty @@ -918,6 +995,8 @@ The style of disabled tabs. The style of the currently hovered tab. +\ **Note:** This style will be drawn with the same width as :ref:`tab_unselected` at minimum. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 8a4932475d1..ee224bfcbf0 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -299,7 +299,11 @@ Show or hide the TileMap's navigation meshes. If set to :ref:`VISIBILITY_MODE_DE - void **set_rendering_quadrant_size** **(** :ref:`int` value **)** - :ref:`int` **get_rendering_quadrant_size** **(** **)** -The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. +The TileMap's quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. :ref:`rendering_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quandrant size groups together ``16 * 16 = 256`` tiles. + +The quadrant size does not apply on Y-sorted layers, as tiles are be grouped by Y position instead in that case. + +\ **Note:** As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the TileMap's local coordinate system. .. rst-class:: classref-item-separator diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 1ada96f7e39..3dd5d2bce69 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -103,6 +103,8 @@ Methods +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`inverse` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_conformal` **(** **)** |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Transform2D` xform **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | @@ -418,6 +420,18 @@ Returns the inverse of the transform, under the assumption that the transformati ---- +.. _class_Transform2D_method_is_conformal: + +.. rst-class:: classref-method + +:ref:`bool` **is_conformal** **(** **)** |const| + +Returns ``true`` if the transform's basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returns ``false`` if the transform's basis has non-uniform scale or shear/skew. This can be used to validate if the transform is non-distorted, which is important for physics and other use cases. + +.. rst-class:: classref-item-separator + +---- + .. _class_Transform2D_method_is_equal_approx: .. rst-class:: classref-method diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index baf0830aad8..e3665f466a1 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -32,35 +32,6 @@ Tutorials - `3D Voxel Demo `__ -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------+------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`separation` | ``4`` | - +-----------------------+------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VBoxContainer_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``4`` - -The vertical space between the **VBoxContainer**'s elements. - .. |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_vflowcontainer.rst b/classes/class_vflowcontainer.rst index cac821ed150..0e53a2ec43d 100644 --- a/classes/class_vflowcontainer.rst +++ b/classes/class_vflowcontainer.rst @@ -28,49 +28,6 @@ Tutorials - :doc:`Using Containers <../tutorials/ui/gui_containers>` -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------+-----------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +-----------------------+-----------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`v_separation` | ``4`` | - +-----------------------+-----------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VFlowContainer_theme_constant_h_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **h_separation** = ``4`` - -The horizontal separation of children nodes. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VFlowContainer_theme_constant_v_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **v_separation** = ``4`` - -The vertical separation of children nodes. - .. |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_viewport.rst b/classes/class_viewport.rst index d861733e4cf..00d5f59346b 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -350,11 +350,19 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +.. _class_Viewport_constant_SCALING_3D_MODE_FSR2: + +.. rst-class:: classref-enumeration-constant + +:ref:`Scaling3DMode` **SCALING_3D_MODE_FSR2** = ``2`` + +Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. + .. _class_Viewport_constant_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Scaling3DMode` **SCALING_3D_MODE_MAX** = ``2`` +:ref:`Scaling3DMode` **SCALING_3D_MODE_MAX** = ``3`` Represents the size of the :ref:`Scaling3DMode` enum. @@ -736,6 +744,14 @@ Draws the decal atlas used by :ref:`Decal`\ s and light projector t +.. _class_Viewport_constant_DEBUG_DRAW_INTERNAL_BUFFER: + +.. rst-class:: classref-enumeration-constant + +:ref:`DebugDraw` **DEBUG_DRAW_INTERNAL_BUFFER** = ``26`` + +Draws the internal resolution buffer of the scene before post-processing is applied. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index c33be5a0699..1ce6a98b3b3 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -35,175 +35,6 @@ Properties | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`decrement_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`increment_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber_highlight` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`grabber_pressed` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`scroll` | - +-----------------------------------+-----------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`scroll_focus` | - +-----------------------------------+-----------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VScrollBar_theme_icon_decrement: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement** - -Icon used as a button to scroll the :ref:`ScrollBar` up. Supports custom step using the :ref:`ScrollBar.custom_step` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_icon_decrement_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement_highlight** - -Displayed when the mouse cursor hovers over the decrement button. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_icon_decrement_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **decrement_pressed** - -Displayed when the decrement button is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_icon_increment: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment** - -Icon used as a button to scroll the :ref:`ScrollBar` down. Supports custom step using the :ref:`ScrollBar.custom_step` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_icon_increment_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment_highlight** - -Displayed when the mouse cursor hovers over the increment button. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_icon_increment_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **increment_pressed** - -Displayed when the increment button is being pressed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_style_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber** - -Used as texture for the grabber, the draggable element representing current scroll. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_style_grabber_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_highlight** - -Used when the mouse hovers over the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_style_grabber_pressed: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_pressed** - -Used when the grabber is being dragged. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_style_scroll: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **scroll** - -Used as background of this :ref:`ScrollBar`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VScrollBar_theme_style_scroll_focus: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **scroll_focus** - -Used as background when the :ref:`ScrollBar` has the GUI focus. - .. |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_vseparator.rst b/classes/class_vseparator.rst index ade81a36d94..ed3dd8bd61d 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -21,49 +21,6 @@ Description A vertical separator used for separating other controls that are arranged **horizontally**. **VSeparator** is purely visual and normally drawn as a :ref:`StyleBoxLine`. -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +---------------------------------+---------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`separation` | ``4`` | - +---------------------------------+---------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`separator` | | - +---------------------------------+---------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VSeparator_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``4`` - -The width of the area covered by the separator. Effectively works like a minimum width. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSeparator_theme_style_separator: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **separator** - -The style for the separator line. Works best with :ref:`StyleBoxLine` (remember to enable :ref:`StyleBoxLine.vertical`). - .. |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_vslider.rst b/classes/class_vslider.rst index 368fe136e69..9cf0cd0fa57 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -35,147 +35,6 @@ Properties | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`center_grabber` | ``0`` | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`grabber_offset` | ``0`` | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber_disabled` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`grabber_highlight` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`tick` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`grabber_area` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`grabber_area_highlight` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`slider` | | - +-----------------------------------+---------------------------------------------------------------------------------+-------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VSlider_theme_constant_center_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`int` **center_grabber** = ``0`` - -Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_constant_grabber_offset: - -.. rst-class:: classref-themeproperty - -:ref:`int` **grabber_offset** = ``0`` - -Horizontal offset of the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_icon_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber** - -The texture for the grabber (the draggable element). - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_icon_grabber_disabled: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber_disabled** - -The texture for the grabber when it's disabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_icon_grabber_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber_highlight** - -The texture for the grabber when it's focused. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_icon_tick: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **tick** - -The texture for the ticks, visible when :ref:`Slider.tick_count` is greater than 0. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_style_grabber_area: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_area** - -The background of the area below the grabber. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_style_grabber_area_highlight: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **grabber_area_highlight** - -The background of the area below the grabber that displays when it's being hovered or focused. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSlider_theme_style_slider: - -.. rst-class:: classref-themeproperty - -:ref:`StyleBox` **slider** - -The background for the whole slider. Determines the width of the ``grabber_area``. - .. |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_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index c68225bff7f..92ce0c6ebcb 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -28,77 +28,6 @@ Tutorials - :doc:`Using Containers <../tutorials/ui/gui_containers>` -.. rst-class:: classref-reftable-group - -Theme Properties ----------------- - -.. table:: - :widths: auto - - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`autohide` | ``1`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`int` | :ref:`separation` | ``12`` | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - | :ref:`Texture2D` | :ref:`grabber` | | - +-----------------------------------+--------------------------------------------------------------------------------------------+--------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Theme Property Descriptions ---------------------------- - -.. _class_VSplitContainer_theme_constant_autohide: - -.. rst-class:: classref-themeproperty - -:ref:`int` **autohide** = ``1`` - -Boolean value. If 1 (``true``), the grabber will hide automatically when it isn't under the cursor. If 0 (``false``), it's always visible. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSplitContainer_theme_constant_minimum_grab_thickness: - -.. rst-class:: classref-themeproperty - -:ref:`int` **minimum_grab_thickness** = ``6`` - -The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSplitContainer_theme_constant_separation: - -.. rst-class:: classref-themeproperty - -:ref:`int` **separation** = ``12`` - -The space between sides of the container. - -.. rst-class:: classref-item-separator - ----- - -.. _class_VSplitContainer_theme_icon_grabber: - -.. rst-class:: classref-themeproperty - -:ref:`Texture2D` **grabber** - -The icon used for the grabber drawn in the middle area. - .. |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/index.rst b/classes/index.rst index 55cf6ffd233..e2417dd744b 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -438,6 +438,7 @@ Resources class_missingresource class_multimesh class_navigationmesh + class_navigationmeshsourcegeometrydata2d class_navigationmeshsourcegeometrydata3d class_navigationpolygon class_noise