diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 6503f8f6d..29a942918 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3671,6 +3671,8 @@ If a property is :ref:`String`, hints that the property represents If a property is :ref:`Array`, hints the editor how to show elements. The ``hint_string`` must encode nested types using ``":"`` and ``"/"``. +If a property is :ref:`Dictionary`, hints the editor how to show elements. The ``hint_string`` is the same as :ref:`Array`, with a ``";"`` separating the key and value. + .. tabs:: @@ -3802,7 +3804,9 @@ Hints that an :ref:`int` property is a pointer. Used by GDExtension. :ref:`PropertyHint` **PROPERTY_HINT_ARRAY_TYPE** = ``31`` -Hints that a property is an :ref:`Array` with the stored type specified in the hint string. +Hints that a property is an :ref:`Array` with the stored type specified in the hint string. The hint string contains the type of the array (e.g. ``"String"``). + +Use the hint string format from :ref:`PROPERTY_HINT_TYPE_STRING` for more control over the stored type. .. _class_@GlobalScope_constant_PROPERTY_HINT_DICTIONARY_TYPE: @@ -3812,6 +3816,8 @@ Hints that a property is an :ref:`Array` with the stored type speci Hints that a property is a :ref:`Dictionary` with the stored types specified in the hint string. The hint string contains the key and value types separated by a semicolon (e.g. ``"int;String"``). +Use the hint string format from :ref:`PROPERTY_HINT_TYPE_STRING` for more control over the stored types. + .. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID: .. rst-class:: classref-enumeration-constant @@ -7214,7 +7220,7 @@ Returns the square root of ``x``, where ``x`` is a non-negative number. sqrt(10.24) # Returns 3.2 sqrt(-1) # Returns NaN -\ **Note:** Negative values of ``x`` return NaN ("Not a Number"). in C#, if you need negative inputs, use ``System.Numerics.Complex``. +\ **Note:** Negative values of ``x`` return NaN ("Not a Number"). In C#, if you need negative inputs, use ``System.Numerics.Complex``. .. rst-class:: classref-item-separator diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 93372bff6..81dc029d2 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -31,9 +31,9 @@ You can access the time information as read-only parameter which is processed an :: - var current_length = $AnimationTree[parameters/AnimationNodeName/current_length] - var current_position = $AnimationTree[parameters/AnimationNodeName/current_position] - var current_delta = $AnimationTree[parameters/AnimationNodeName/current_delta] + var current_length = $AnimationTree["parameters/AnimationNodeName/current_length"] + var current_position = $AnimationTree["parameters/AnimationNodeName/current_position"] + var current_delta = $AnimationTree["parameters/AnimationNodeName/current_delta"] .. rst-class:: classref-introduction-group diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index c2efe9588..fb34d4cee 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -50,25 +50,27 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_node_list`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -223,6 +225,18 @@ Returns the sub animation node with the specified ``name``. ---- +.. _class_AnimationNodeBlendTree_method_get_node_list: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`StringName`\] **get_node_list**\ (\ ) |const| :ref:`🔗` + +Returns a list containing the names of all sub animation nodes in this blend tree. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationNodeBlendTree_method_get_node_position: .. rst-class:: classref-method diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index f22a1a63f..abf6e5abb 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -76,6 +76,8 @@ Methods +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_node_list`\ (\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_node_name`\ (\ node\: :ref:`AnimationNode`\ ) |const| | +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | @@ -261,6 +263,18 @@ Returns the animation node with the given name. ---- +.. _class_AnimationNodeStateMachine_method_get_node_list: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`StringName`\] **get_node_list**\ (\ ) |const| :ref:`🔗` + +Returns a list containing the names of all animation nodes in this state machine. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationNodeStateMachine_method_get_node_name: .. rst-class:: classref-method diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 3aee9e350..e050a2b87 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -32,13 +32,15 @@ Properties .. table:: :widths: auto - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`bone_idx` | ``-1`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`bone_name` | ``""`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`override_pose` | ``false`` | - +-----------------------------+---------------------------------------------------------------------+-----------+ + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bone_idx` | ``-1`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`bone_name` | ``""`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`override_pose` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_control.rst b/classes/class_control.rst index 9013f47b9..6d9c2c5d3 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -2711,7 +2711,7 @@ Returns combined minimum size from :ref:`custom_minimum_size` **get_cursor_shape**\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| :ref:`🔗` -Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. +Returns the mouse cursor shape for this control when hovered over ``position`` in local coordinates. For most controls, this is the same as :ref:`mouse_default_cursor_shape`, but some built-in controls implement more complex logic. See :ref:`CursorShape`. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index bcd57e87f..5fb59f93c 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -313,6 +313,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/zoom_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/polygon_editor/auto_bake_delay` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | @@ -2553,6 +2555,18 @@ If ``true``, warps the mouse around the 2D viewport while panning in the 2D edit ---- +.. _class_EditorSettings_property_editors/panning/zoom_style: + +.. rst-class:: classref-property + +:ref:`int` **editors/panning/zoom_style** :ref:`🔗` + +The mouse cursor movement direction to use when drag-zooming in any editor (except 3D scene editor) by moving the mouse. This does not affect zooming with the mouse wheel. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/polygon_editor/auto_bake_delay: .. rst-class:: classref-property diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst index ad89a3e77..6eaf0b4e4 100644 --- a/classes/class_foldablecontainer.rst +++ b/classes/class_foldablecontainer.rst @@ -40,27 +40,27 @@ Properties .. table:: :widths: auto - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`FoldableGroup` | :ref:`foldable_group` | | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`bool` | :ref:`folded` | ``false`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`String` | :ref:`language` | ``""`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`String` | :ref:`text` | ``""`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`OverrunBehavior` | :ref:`text_overrun_behavior` | ``0`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`title_alignment` | ``0`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ - | :ref:`TitlePosition` | :ref:`title_position` | ``0`` | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FoldableGroup` | :ref:`foldable_group` | | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`bool` | :ref:`folded` | ``false`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`title` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`title_alignment` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TitlePosition` | :ref:`title_position` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`title_text_direction` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`title_text_overrun_behavior` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -194,7 +194,7 @@ Property Descriptions - |void| **set_foldable_group**\ (\ value\: :ref:`FoldableGroup`\ ) - :ref:`FoldableGroup` **get_foldable_group**\ (\ ) -The :ref:`FoldableGroup` associated with the container. +The :ref:`FoldableGroup` associated with the container. When multiple **FoldableContainer** nodes share the same group, only one of them is allowed to be unfolded. .. rst-class:: classref-item-separator @@ -234,52 +234,18 @@ Language code used for text shaping algorithms. If left empty, current locale is ---- -.. _class_FoldableContainer_property_text: +.. _class_FoldableContainer_property_title: .. rst-class:: classref-property -:ref:`String` **text** = ``""`` :ref:`🔗` +:ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget -- |void| **set_text**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_text**\ (\ ) +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) -The Container's title text. - -.. rst-class:: classref-item-separator - ----- - -.. _class_FoldableContainer_property_text_direction: - -.. rst-class:: classref-property - -:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) -- :ref:`TextDirection` **get_text_direction**\ (\ ) - -Base text writing direction. - -.. rst-class:: classref-item-separator - ----- - -.. _class_FoldableContainer_property_text_overrun_behavior: - -.. rst-class:: classref-property - -:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) -- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) - -Defines the behavior of the **FoldableContainer** when the text is longer than the available space. +The container's title text. .. rst-class:: classref-item-separator @@ -315,6 +281,40 @@ Title's horizontal text alignment as defined in the :ref:`HorizontalAlignment` enum. +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_text_direction: + +.. rst-class:: classref-property + +:ref:`TextDirection` **title_text_direction** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_title_text_direction**\ (\ ) + +Title text writing direction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_text_overrun_behavior: + +.. rst-class:: classref-property + +:ref:`OverrunBehavior` **title_text_overrun_behavior** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_title_text_overrun_behavior**\ (\ ) + +Defines the behavior of the title when the text is longer than the available space. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_labelsettings.rst b/classes/class_labelsettings.rst index ccc4889dd..7244c1c14 100644 --- a/classes/class_labelsettings.rst +++ b/classes/class_labelsettings.rst @@ -29,27 +29,73 @@ Properties .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Font` | :ref:`font` | | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`font_size` | ``16`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`line_spacing` | ``3.0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`outline_color` | ``Color(1, 1, 1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`paragraph_spacing` | ``0.0`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`shadow_color` | ``Color(0, 0, 0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`Vector2` | :ref:`shadow_offset` | ``Vector2(1, 1)`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`shadow_size` | ``1`` | - +-------------------------------+--------------------------------------------------------------------------+-----------------------+ + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Font` | :ref:`font` | | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`font_size` | ``16`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`line_spacing` | ``3.0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`outline_color` | ``Color(1, 1, 1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`paragraph_spacing` | ``0.0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`shadow_color` | ``Color(0, 0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Vector2` | :ref:`shadow_offset` | ``Vector2(1, 1)`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`shadow_size` | ``1`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stacked_outline_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`stacked_shadow_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+-----------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_stacked_outline`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_stacked_shadow`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_stacked_outline_color`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_stacked_outline_size`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_stacked_shadow_color`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_stacked_shadow_offset`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_stacked_shadow_outline_size`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_stacked_outline`\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_stacked_shadow`\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_stacked_outline`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_stacked_shadow`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_outline_color`\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_outline_size`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_color`\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_offset`\ (\ index\: :ref:`int`, offset\: :ref:`Vector2`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stacked_shadow_outline_size`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -226,6 +272,237 @@ Offset of the shadow effect, in pixels. Size of the shadow effect. +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_property_stacked_outline_count: + +.. rst-class:: classref-property + +:ref:`int` **stacked_outline_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stacked_outline_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stacked_outline_count**\ (\ ) + +The number of stacked outlines. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_property_stacked_shadow_count: + +.. rst-class:: classref-property + +:ref:`int` **stacked_shadow_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_stacked_shadow_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stacked_shadow_count**\ (\ ) + +Returns the stacked shadow count. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_LabelSettings_method_add_stacked_outline: + +.. rst-class:: classref-method + +|void| **add_stacked_outline**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` + +Adds a new stacked outline to the label at the given ``index``. If ``index`` is ``-1``, the new stacked outline will be added at the end of the list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_add_stacked_shadow: + +.. rst-class:: classref-method + +|void| **add_stacked_shadow**\ (\ index\: :ref:`int` = -1\ ) :ref:`🔗` + +Adds a new stacked shadow to the label at the given ``index``. If ``index`` is ``-1``, the new stacked shadow will be added at the end of the list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_outline_color: + +.. rst-class:: classref-method + +:ref:`Color` **get_stacked_outline_color**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the color of the stacked outline at ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_outline_size: + +.. rst-class:: classref-method + +:ref:`int` **get_stacked_outline_size**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the size of the stacked outline at ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_color: + +.. rst-class:: classref-method + +:ref:`Color` **get_stacked_shadow_color**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the color of the stacked shadow at ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_offset: + +.. rst-class:: classref-method + +:ref:`Vector2` **get_stacked_shadow_offset**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the offset of the stacked shadow at ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_get_stacked_shadow_outline_size: + +.. rst-class:: classref-method + +:ref:`int` **get_stacked_shadow_outline_size**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the outline size of the stacked shadow at ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_move_stacked_outline: + +.. rst-class:: classref-method + +|void| **move_stacked_outline**\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` + +Moves the stacked outline at index ``from_index`` to the given position ``to_position`` in the array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_move_stacked_shadow: + +.. rst-class:: classref-method + +|void| **move_stacked_shadow**\ (\ from_index\: :ref:`int`, to_position\: :ref:`int`\ ) :ref:`🔗` + +Moves the stacked shadow at index ``from_index`` to the given position ``to_position`` in the array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_remove_stacked_outline: + +.. rst-class:: classref-method + +|void| **remove_stacked_outline**\ (\ index\: :ref:`int`\ ) :ref:`🔗` + +Removes the stacked outline at index ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_remove_stacked_shadow: + +.. rst-class:: classref-method + +|void| **remove_stacked_shadow**\ (\ index\: :ref:`int`\ ) :ref:`🔗` + +Removes the stacked shadow at index ``index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_outline_color: + +.. rst-class:: classref-method + +|void| **set_stacked_outline_color**\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` + +Sets the color of the stacked outline identified by the given ``index`` to ``color``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_outline_size: + +.. rst-class:: classref-method + +|void| **set_stacked_outline_size**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +Sets the size of the stacked outline identified by the given ``index`` to ``size``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_color: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_color**\ (\ index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` + +Sets the color of the stacked shadow identified by the given ``index`` to ``color``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_offset: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_offset**\ (\ index\: :ref:`int`, offset\: :ref:`Vector2`\ ) :ref:`🔗` + +Sets the offset of the stacked shadow identified by the given ``index`` to ``offset``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LabelSettings_method_set_stacked_shadow_outline_size: + +.. rst-class:: classref-method + +|void| **set_stacked_shadow_outline_size**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +Sets the outline size of the stacked shadow identified by the given ``index`` to ``size``. + .. |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_meshinstance3d.rst b/classes/class_meshinstance3d.rst index c0058626e..ca8715a08 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -21,7 +21,7 @@ Node that instances meshes into a scenario. Description ----------- -MeshInstance3D is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used render 3D geometry and can be used to instance a single :ref:`Mesh` in many places. This allows reusing geometry, which can save on resources. When a :ref:`Mesh` has to be instantiated more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance3D` instead. +MeshInstance3D is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used to render 3D geometry and can be used to instance a single :ref:`Mesh` in many places. This allows reusing geometry, which can save on resources. When a :ref:`Mesh` has to be instantiated more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance3D` instead. .. rst-class:: classref-introduction-group diff --git a/classes/class_node.rst b/classes/class_node.rst index 4877ae410..1f1bbfb96 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -189,6 +189,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_node_or_null`\ (\ path\: :ref:`NodePath`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`get_orphan_node_ids`\ (\ ) |static| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_parent`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_path`\ (\ ) |const| | @@ -2340,6 +2342,20 @@ Fetches a node by :ref:`NodePath`. Similar to :ref:`get_node()`\[:ref:`int`\] **get_orphan_node_ids**\ (\ ) |static| :ref:`🔗` + +Returns object IDs of all orphan nodes (nodes outside the :ref:`SceneTree`). Used for debugging. + +\ **Note:** :ref:`get_orphan_node_ids()` only works in debug builds. When called in a project exported in release mode, :ref:`get_orphan_node_ids()` will return an empty array. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_get_parent: .. rst-class:: classref-method diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index a7c2621c5..80c2b1567 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -10,6 +10,8 @@ ParallaxBackground ================== +**Deprecated:** Use the :ref:`Parallax2D` node instead. + **Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` A node used to create a parallax scrolling background. diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 7dc0f710a..3bbf24838 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -10,6 +10,8 @@ ParallaxLayer ============= +**Deprecated:** Use the :ref:`Parallax2D` node instead. + **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A parallax scrolling layer to be used with :ref:`ParallaxBackground`. diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 596e11488..65b8ea146 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -495,8 +495,6 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_visibility_range`\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`instance_reset_physics_interpolation`\ (\ instance\: :ref:`RID`\ ) | - +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_base`\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_blend_shape_weight`\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) | @@ -507,8 +505,6 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_ignore_culling`\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`instance_set_interpolated`\ (\ instance\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | - +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_layer_mask`\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_pivot_data`\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) | @@ -8862,20 +8858,6 @@ Sets the visibility range values for the given geometry instance. Equivalent to ---- -.. _class_RenderingServer_method_instance_reset_physics_interpolation: - -.. rst-class:: classref-method - -|void| **instance_reset_physics_interpolation**\ (\ instance\: :ref:`RID`\ ) :ref:`🔗` - -Prevents physics interpolation for the current physics tick. - -This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location. - -.. rst-class:: classref-item-separator - ----- - .. _class_RenderingServer_method_instance_set_base: .. rst-class:: classref-method @@ -8936,18 +8918,6 @@ If ``true``, ignores both frustum and occlusion culling on the specified 3D geom ---- -.. _class_RenderingServer_method_instance_set_interpolated: - -.. rst-class:: classref-method - -|void| **instance_set_interpolated**\ (\ instance\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` - -Turns on and off physics interpolation for the instance. - -.. rst-class:: classref-item-separator - ----- - .. _class_RenderingServer_method_instance_set_layer_mask: .. rst-class:: classref-method diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 4855a2530..f9faa6e54 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -42,6 +42,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save`\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_uid`\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -195,6 +197,20 @@ Returns :ref:`@GlobalScope.OK` on success. \ **Note:** When the project is running, any generated UID associated with the resource will not be saved as the required code is only executed in editor mode. +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceSaver_method_set_uid: + +.. rst-class:: classref-method + +:ref:`Error` **set_uid**\ (\ resource\: :ref:`String`, uid\: :ref:`int`\ ) :ref:`🔗` + +Sets the UID of the given ``resource`` path to ``uid``. You can generate a new UID using :ref:`ResourceUID.create_id()`. + +Since resources will normally get a UID automatically, this method is only useful in very specific cases. + .. |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_richtextlabel.rst b/classes/class_richtextlabel.rst index ea63f3f16..ed95d658d 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -143,10 +143,14 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_height`\ (\ line\: :ref:`int`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_line_offset`\ (\ line\: :ref:`int`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_paragraph_count`\ (\ ) |const| | @@ -1268,6 +1272,20 @@ Returns the total number of lines in the text. Wrapped text is counted as multip ---- +.. _class_RichTextLabel_method_get_line_height: + +.. rst-class:: classref-method + +:ref:`int` **get_line_height**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the height of the line found at the provided index. + +\ **Note:** If :ref:`threaded` is enabled, this method returns a value for the loaded part of the document. Use :ref:`is_finished()` or :ref:`finished` to determine whether the document is fully loaded. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_get_line_offset: .. rst-class:: classref-method @@ -1298,6 +1316,20 @@ Returns the indexes of the first and last visible characters for the given ``lin ---- +.. _class_RichTextLabel_method_get_line_width: + +.. rst-class:: classref-method + +:ref:`int` **get_line_width**\ (\ line\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the width of the line found at the provided index. + +\ **Note:** If :ref:`threaded` is enabled, this method returns a value for the loaded part of the document. Use :ref:`is_finished()` or :ref:`finished` to determine whether the document is fully loaded. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_get_menu: .. rst-class:: classref-method diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 0f49afd9a..a8c2f48f0 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -883,6 +883,8 @@ Sets a custom :ref:`MultiplayerAPI` with the given ``root_ \ **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. +\ **Note:** :ref:`set_multiplayer()` should be called *before* the child nodes are ready at the given ``root_path``. If multiplayer nodes like :ref:`MultiplayerSpawner` or :ref:`MultiplayerSynchronizer` are added to the tree before the custom multiplayer API is set, they will not work. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_string.rst b/classes/class_string.rst index 376ad7c6e..d43073dc2 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1086,7 +1086,7 @@ See also :ref:`is_valid_unicode_identifier()` **is_valid_filename**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). +Returns ``true`` if this string is a valid file name. A valid file name cannot be empty, begin or end with space characters, or contain characters that are not allowed (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). .. rst-class:: classref-item-separator diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index cb9d9b53f..b9d518078 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -1026,7 +1026,7 @@ See also :ref:`is_valid_unicode_identifier()` **is_valid_filename**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). +Returns ``true`` if this string is a valid file name. A valid file name cannot be empty, begin or end with space characters, or contain characters that are not allowed (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). .. rst-class:: classref-item-separator diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 916996312..27bc442f9 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -38,35 +38,37 @@ Properties .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`brake` | ``0.0`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`damping_compression` | ``0.83`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`damping_relaxation` | ``0.88`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`engine_force` | ``0.0`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`steering` | ``0.0`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`suspension_max_force` | ``6000.0`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`suspension_stiffness` | ``5.88`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`suspension_travel` | ``0.2`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`use_as_steering` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`bool` | :ref:`use_as_traction` | ``false`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`wheel_friction_slip` | ``10.5`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`wheel_radius` | ``0.5`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`wheel_rest_length` | ``0.15`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`wheel_roll_influence` | ``0.1`` | - +---------------------------+---------------------------------------------------------------------------------+------------+ + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`brake` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`damping_compression` | ``0.83`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`damping_relaxation` | ``0.88`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`engine_force` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`steering` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`suspension_max_force` | ``6000.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`suspension_stiffness` | ``5.88`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`suspension_travel` | ``0.2`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_as_steering` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_as_traction` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wheel_friction_slip` | ``10.5`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wheel_radius` | ``0.5`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wheel_rest_length` | ``0.15`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wheel_roll_influence` | ``0.1`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_zippacker.rst b/classes/class_zippacker.rst index e82d8aabc..a12945bfe 100644 --- a/classes/class_zippacker.rst +++ b/classes/class_zippacker.rst @@ -38,6 +38,18 @@ This class implements a writer that allows storing the multiple blobs in a ZIP a .. rst-class:: classref-reftable-group +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------+----------------------------------------------------------------------+--------+ + | :ref:`int` | :ref:`compression_level` | ``-1`` | + +-----------------------+----------------------------------------------------------------------+--------+ + +.. rst-class:: classref-reftable-group + Methods ------- @@ -95,6 +107,70 @@ Append a new zip archive to the end of the already existing file at the given pa Add new files to the existing zip archive at the given path. +.. rst-class:: classref-item-separator + +---- + +.. _enum_ZIPPacker_CompressionLevel: + +.. rst-class:: classref-enumeration + +enum **CompressionLevel**: :ref:`🔗` + +.. _class_ZIPPacker_constant_COMPRESSION_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressionLevel` **COMPRESSION_DEFAULT** = ``-1`` + +Start a file with the default Deflate compression level (``6``). This is a good compromise between speed and file size. + +.. _class_ZIPPacker_constant_COMPRESSION_NONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressionLevel` **COMPRESSION_NONE** = ``0`` + +Start a file with no compression. This is also known as the "Store" compression mode and is the fastest method of packing files inside a ZIP archive. Consider using this mode for files that are already compressed (such as JPEG, PNG, MP3, or Ogg Vorbis files). + +.. _class_ZIPPacker_constant_COMPRESSION_FAST: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressionLevel` **COMPRESSION_FAST** = ``1`` + +Start a file with the fastest Deflate compression level (``1``). This is fast to compress, but results in larger file sizes than :ref:`COMPRESSION_DEFAULT`. Decompression speed is generally unaffected by the chosen compression level. + +.. _class_ZIPPacker_constant_COMPRESSION_BEST: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressionLevel` **COMPRESSION_BEST** = ``9`` + +Start a file with the the best Deflate compression level (``9``). This is slow to compress, but results in smaller file sizes than :ref:`COMPRESSION_DEFAULT`. Decompression speed is generally unaffected by the chosen compression level. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ZIPPacker_property_compression_level: + +.. rst-class:: classref-property + +:ref:`int` **compression_level** = ``-1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_compression_level**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_compression_level**\ (\ ) + +The compression level used when :ref:`start_file()` is called. Use :ref:`CompressionLevel` as a reference. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_zipreader.rst b/classes/class_zipreader.rst index c3e7273bc..bad0f267a 100644 --- a/classes/class_zipreader.rst +++ b/classes/class_zipreader.rst @@ -67,17 +67,19 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`close`\ (\ ) | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`file_exists`\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_files`\ (\ ) | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`open`\ (\ path\: :ref:`String`\ ) | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`read_file`\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`close`\ (\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_exists`\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_compression_level`\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_files`\ (\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`open`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`read_file`\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -114,6 +116,18 @@ Must be called after :ref:`open()`. ---- +.. _class_ZIPReader_method_get_compression_level: + +.. rst-class:: classref-method + +:ref:`int` **get_compression_level**\ (\ path\: :ref:`String`, case_sensitive\: :ref:`bool` = true\ ) :ref:`🔗` + +Returns the compression level of the file in the loaded zip archive. Returns ``-1`` if the file doesn't exist or any other error occurs. Must be called after :ref:`open()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ZIPReader_method_get_files: .. rst-class:: classref-method