diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 4f1852b7c16..4d37c7df846 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -160,7 +160,7 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`scale_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`track_find_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| | + | :ref:`int` | :ref:`track_find_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false, backward\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap`\ (\ track_idx\: :ref:`int`\ ) |const| | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1039,12 +1039,16 @@ Returns the interpolated scale value at the given time (in seconds). The ``track .. rst-class:: classref-method -:ref:`int` **track_find_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| :ref:`🔗` +:ref:`int` **track_find_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false, backward\: :ref:`bool` = false\ ) |const| :ref:`🔗` Finds the key index by time in a given track. Optionally, only find it if the approx/exact time is given. If ``limit`` is ``true``, it does not return keys outside the animation range. +If ``backward`` is ``true``, the direction is reversed in methods that rely on one directional processing. + +For example, in case ``find_mode`` is :ref:`FIND_MODE_NEAREST`, if there is no key in the current position just after seeked, the first key found is retrieved by searching before the position, but if ``backward`` is ``true``, the first key found is retrieved after the position. + .. rst-class:: classref-item-separator ---- @@ -1383,6 +1387,8 @@ Returns the update mode of a value track. Returns the interpolated value at the given time (in seconds). The ``track_idx`` must be the index of a value track. +A ``backward`` mainly affects the direction of key retrieval of the track with :ref:`UPDATE_DISCRETE` converted by :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS` to match the result with :ref:`track_find_key`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 1a0809a5fa8..e699ff6d776 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -864,13 +864,15 @@ Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Ve .. code-tab:: gdscript - var my_basis = Basis(Vector3(1, 1, 1), Vector3(1, 1, 1), Vector3(0, 2, 5)) - print(my_basis * Vector3(1, 2, 3)) # Prints (7, 3, 16) + # Basis that swaps the X/Z axes and doubles the scale. + var my_basis = Basis(Vector3(0, 2, 0), Vector3(2, 0, 0), Vector3(0, 0, 2)) + print(my_basis * Vector3(1, 2, 3)) # Prints (4, 2, 6) .. code-tab:: csharp - var myBasis = new Basis(new Vector3(1, 1, 1), new Vector3(1, 1, 1), new Vector3(0, 2, 5)); - GD.Print(my_basis * new Vector3(1, 2, 3)); // Prints (7, 3, 16) + // Basis that swaps the X/Z axes and doubles the scale. + var myBasis = new Basis(new Vector3(0, 2, 0), new Vector3(2, 0, 0), new Vector3(0, 0, 2)); + GD.Print(myBasis * new Vector3(1, 2, 3)); // Prints (4, 2, 6) diff --git a/classes/class_button.rst b/classes/class_button.rst index 442fac68c8e..051c8071d05 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -111,67 +111,69 @@ 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(0, 0, 0, 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` | | - +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ + | :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(0, 0, 0, 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:`align_to_largest_stylebox` | ``0`` | + +-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ + | :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 @@ -549,6 +551,18 @@ Icon modulate :ref:`Color` used when the **Button** is being presse ---- +.. _class_Button_theme_constant_align_to_largest_stylebox: + +.. rst-class:: classref-themeproperty + +:ref:`int` **align_to_largest_stylebox** = ``0`` :ref:`🔗` + +This constant acts as a boolean. If ``true``, text and icon are always aligned to the largest stylebox margins, otherwise it's aligned to the current button state stylebox margins. + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_constant_h_separation: .. rst-class:: classref-themeproperty diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index a0c65d2a9ff..12dbf7269bf 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -226,41 +226,43 @@ Methods .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ key\: :ref:`Variant`\ ) | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`find_key`\ (\ value\: :ref:`Variant`\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_or_add`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ key\: :ref:`Variant`\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_all`\ (\ keys\: :ref:`Array`\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_read_only`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`keys`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`make_read_only`\ (\ ) | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`merge`\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`merged`\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`values`\ (\ ) |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ key\: :ref:`Variant`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`find_key`\ (\ value\: :ref:`Variant`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_or_add`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ key\: :ref:`Variant`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_all`\ (\ keys\: :ref:`Array`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_read_only`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`keys`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_read_only`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge`\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`merged`\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`recursive_equal`\ (\ dictionary\: :ref:`Dictionary`, recursion_count\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`values`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -619,6 +621,18 @@ See also :ref:`merge`. ---- +.. _class_Dictionary_method_recursive_equal: + +.. rst-class:: classref-method + +:ref:`bool` **recursive_equal**\ (\ dictionary\: :ref:`Dictionary`, recursion_count\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the two dictionaries contain the same keys and values, inner **Dictionary** and :ref:`Array` keys and values are compared recursively. + +.. rst-class:: classref-item-separator + +---- + .. _class_Dictionary_method_size: .. rst-class:: classref-method diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index d2904a43374..bc1ad69f0f2 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -74,17 +74,23 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_capture`\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_capture`\ (\ capture\: :ref:`String`\ ) |virtual| |const| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_setup_session`\ (\ session_id\: :ref:`int`\ ) |virtual| | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorDebuggerSession` | :ref:`get_session`\ (\ id\: :ref:`int`\ ) | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_sessions`\ (\ ) | - +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_breakpoint_set_in_tree`\ (\ script\: :ref:`Script`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_breakpoints_cleared_in_tree`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_capture`\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_goto_script_line`\ (\ script\: :ref:`Script`, line\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_capture`\ (\ capture\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_setup_session`\ (\ session_id\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorDebuggerSession` | :ref:`get_session`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_sessions`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -95,6 +101,30 @@ Methods Method Descriptions ------------------- +.. _class_EditorDebuggerPlugin_private_method__breakpoint_set_in_tree: + +.. rst-class:: classref-method + +|void| **_breakpoint_set_in_tree**\ (\ script\: :ref:`Script`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` + +Override this method to be notified when a breakpoint is set in the editor. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDebuggerPlugin_private_method__breakpoints_cleared_in_tree: + +.. rst-class:: classref-method + +|void| **_breakpoints_cleared_in_tree**\ (\ ) |virtual| :ref:`🔗` + +Override this method to be notified when all breakpoints are cleared in the editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDebuggerPlugin_private_method__capture: .. rst-class:: classref-method @@ -107,6 +137,18 @@ Override this method to process incoming messages. The ``session_id`` is the ID ---- +.. _class_EditorDebuggerPlugin_private_method__goto_script_line: + +.. rst-class:: classref-method + +|void| **_goto_script_line**\ (\ script\: :ref:`Script`, line\: :ref:`int`\ ) |virtual| :ref:`🔗` + +Override this method to be notified when a breakpoint line has been clicked in the debugger breakpoint panel. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDebuggerPlugin_private_method__has_capture: .. rst-class:: classref-method diff --git a/classes/class_editordebuggersession.rst b/classes/class_editordebuggersession.rst index d4e13fa6771..96922731b1a 100644 --- a/classes/class_editordebuggersession.rst +++ b/classes/class_editordebuggersession.rst @@ -44,6 +44,8 @@ Methods +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_breakpoint`\ (\ path\: :ref:`String`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`toggle_profiler`\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -181,6 +183,18 @@ Sends the given ``message`` to the attached remote instance, optionally passing ---- +.. _class_EditorDebuggerSession_method_set_breakpoint: + +.. rst-class:: classref-method + +|void| **set_breakpoint**\ (\ path\: :ref:`String`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +Enables or disables a specific breakpoint based on ``enabled``, updating the Editor Breakpoint Panel accordingly. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDebuggerSession_method_toggle_profiler: .. rst-class:: classref-method diff --git a/classes/class_enginedebugger.rst b/classes/class_enginedebugger.rst index be314451dc2..28db4834587 100644 --- a/classes/class_enginedebugger.rst +++ b/classes/class_enginedebugger.rst @@ -29,29 +29,53 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_capture`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_profiler`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_active`\ (\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_profiling`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`profiler_add_frame_data`\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`profiler_enable`\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_message_capture`\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_profiler`\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_message_capture`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_profiler`\ (\ name\: :ref:`StringName`\ ) | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_breakpoints`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`debug`\ (\ can_continue\: :ref:`bool` = true, is_error_breakpoint\: :ref:`bool` = false\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_depth`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_lines_left`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_capture`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_profiler`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_breakpoint`\ (\ line\: :ref:`int`, source\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_breakpoint`\ (\ line\: :ref:`int`, source\: :ref:`StringName`\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_profiling`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_skipping_breakpoints`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`line_poll`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`profiler_add_frame_data`\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`profiler_enable`\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_message_capture`\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_profiler`\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_breakpoint`\ (\ line\: :ref:`int`, source\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`script_debug`\ (\ language\: :ref:`ScriptLanguage`, can_continue\: :ref:`bool` = true, is_error_breakpoint\: :ref:`bool` = false\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_depth`\ (\ depth\: :ref:`int`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_lines_left`\ (\ lines\: :ref:`int`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_message_capture`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_profiler`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,6 +86,58 @@ Methods Method Descriptions ------------------- +.. _class_EngineDebugger_method_clear_breakpoints: + +.. rst-class:: classref-method + +|void| **clear_breakpoints**\ (\ ) :ref:`🔗` + +Clears all breakpoints. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_debug: + +.. rst-class:: classref-method + +|void| **debug**\ (\ can_continue\: :ref:`bool` = true, is_error_breakpoint\: :ref:`bool` = false\ ) :ref:`🔗` + +Starts a debug break in script execution, optionally specifying whether the program can continue based on ``can_continue`` and whether the break was due to a breakpoint. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_get_depth: + +.. rst-class:: classref-method + +:ref:`int` **get_depth**\ (\ ) |const| :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns the current debug depth. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_get_lines_left: + +.. rst-class:: classref-method + +:ref:`int` **get_lines_left**\ (\ ) |const| :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns the number of lines that remain. + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_has_capture: .. rst-class:: classref-method @@ -86,6 +162,18 @@ Returns ``true`` if a profiler with the given name is present otherwise ``false` ---- +.. _class_EngineDebugger_method_insert_breakpoint: + +.. rst-class:: classref-method + +|void| **insert_breakpoint**\ (\ line\: :ref:`int`, source\: :ref:`StringName`\ ) :ref:`🔗` + +Inserts a new breakpoint with the given ``source`` and ``line``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_is_active: .. rst-class:: classref-method @@ -98,6 +186,18 @@ Returns ``true`` if the debugger is active otherwise ``false``. ---- +.. _class_EngineDebugger_method_is_breakpoint: + +.. rst-class:: classref-method + +:ref:`bool` **is_breakpoint**\ (\ line\: :ref:`int`, source\: :ref:`StringName`\ ) |const| :ref:`🔗` + +Returns ``true`` if the given ``source`` and ``line`` represent an existing breakpoint. + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_is_profiling: .. rst-class:: classref-method @@ -110,6 +210,30 @@ Returns ``true`` if a profiler with the given name is present and active otherwi ---- +.. _class_EngineDebugger_method_is_skipping_breakpoints: + +.. rst-class:: classref-method + +:ref:`bool` **is_skipping_breakpoints**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if the debugger is skipping breakpoints otherwise ``false``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_line_poll: + +.. rst-class:: classref-method + +|void| **line_poll**\ (\ ) :ref:`🔗` + +Forces a processing loop of debugger events. The purpose of this method is just processing events every now and then when the script might get too busy, so that bugs like infinite loops can be caught + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_profiler_add_frame_data: .. rst-class:: classref-method @@ -160,6 +284,30 @@ Registers a profiler with the given ``name``. See :ref:`EngineProfiler`, source\: :ref:`StringName`\ ) :ref:`🔗` + +Removes a breakpoint with the given ``source`` and ``line``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_script_debug: + +.. rst-class:: classref-method + +|void| **script_debug**\ (\ language\: :ref:`ScriptLanguage`, can_continue\: :ref:`bool` = true, is_error_breakpoint\: :ref:`bool` = false\ ) :ref:`🔗` + +Starts a debug break in script execution, optionally specifying whether the program can continue based on ``can_continue`` and whether the break was due to a breakpoint. + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_send_message: .. rst-class:: classref-method @@ -172,6 +320,34 @@ Sends a message with given ``message`` and ``data`` array. ---- +.. _class_EngineDebugger_method_set_depth: + +.. rst-class:: classref-method + +|void| **set_depth**\ (\ depth\: :ref:`int`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Sets the current debugging depth. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EngineDebugger_method_set_lines_left: + +.. rst-class:: classref-method + +|void| **set_lines_left**\ (\ lines\: :ref:`int`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Sets the current debugging lines that remain. + +.. rst-class:: classref-item-separator + +---- + .. _class_EngineDebugger_method_unregister_message_capture: .. rst-class:: classref-method diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 53c2e03f8c0..29a36fa9bb1 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -636,8 +636,6 @@ The global contrast value of the rendered scene (default value is 1). Effective If ``true``, enables the ``adjustment_*`` properties provided by this resource. If ``false``, modifications to the ``adjustment_*`` properties will have no effect on the rendered scene. -\ **Note:** Adjustments are only supported in the Forward+ and Mobile rendering methods, not Compatibility. - .. rst-class:: classref-item-separator ---- diff --git a/classes/class_image.rst b/classes/class_image.rst index 62546896d48..4e594fca6d5 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -81,6 +81,8 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`create`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`create_empty`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`create_from_data`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`crop`\ (\ width\: :ref:`int`, height\: :ref:`int`\ ) | @@ -105,6 +107,8 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`get_data`\ (\ ) |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_data_size`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height`\ (\ ) |const| | @@ -1026,6 +1030,20 @@ Copies ``src`` image to this image. :ref:`Image` **create**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| :ref:`🔗` +**Deprecated:** Use :ref:`create_empty`. + +Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Image_method_create_empty: + +.. rst-class:: classref-method + +:ref:`Image` **create_empty**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| :ref:`🔗` + Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps`. .. rst-class:: classref-item-separator @@ -1180,6 +1198,18 @@ Returns a copy of the image's raw data. ---- +.. _class_Image_method_get_data_size: + +.. rst-class:: classref-method + +:ref:`int` **get_data_size**\ (\ ) |const| :ref:`🔗` + +Returns size (in bytes) of the image's raw data. + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_get_format: .. rst-class:: classref-method diff --git a/classes/class_input.rst b/classes/class_input.rst index c33486b02f1..bae03e0b96f 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -1115,10 +1115,10 @@ Stops the vibration of the joypad started with :ref:`start_joy_vibration` = 500, amplitude\: :ref:`float` = -1.0\ ) :ref:`🔗` -**Note:** While ``amplitude`` expects a value between 0 and 1, -1 does the default amplitude for the device. - Vibrate the handheld device for the specified duration in milliseconds. +\ ``amplitude`` is the strength of the vibration, as a value between ``0.0`` and ``1.0``. If set to ``-1.0``, the default vibration strength of the device is used. + \ **Note:** This method is implemented on Android, iOS, and Web. It has no effect on other platforms. \ **Note:** For Android, :ref:`vibrate_handheld` requires enabling the ``VIBRATE`` permission in the export preset. Otherwise, :ref:`vibrate_handheld` will have no effect. diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index a64cbf219ef..5c3fde62ee9 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -57,6 +57,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_debug_get_stack_level_members`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_stack_level_source`\ (\ level\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_debug_parse_stack_level_expression`\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_find_function`\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| | @@ -694,6 +696,18 @@ Method Descriptions ---- +.. _class_ScriptLanguageExtension_private_method__debug_get_stack_level_source: + +.. rst-class:: classref-method + +:ref:`String` **_debug_get_stack_level_source**\ (\ level\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +Returns the source associated with a given debug stack position. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptLanguageExtension_private_method__debug_parse_stack_level_expression: .. rst-class:: classref-method diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 7ecafa644b2..9616f8efb98 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -99,6 +99,8 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_bone_rest`\ (\ bone_idx\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_concatenated_bone_names`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_parentless_bones`\ (\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_version`\ (\ ) |const| | @@ -602,6 +604,20 @@ Returns the rest transform for a bone ``bone_idx``. ---- +.. _class_Skeleton3D_method_get_concatenated_bone_names: + +.. rst-class:: classref-method + +:ref:`StringName` **get_concatenated_bone_names**\ (\ ) |const| :ref:`🔗` + +Returns all bone names concatenated with commas (``,``) as a single :ref:`StringName`. + +It is useful to set it as a hint for the enum property. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_get_parentless_bones: .. rst-class:: classref-method diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index 2095f6ca5a0..401d766dee5 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -49,9 +49,11 @@ Methods .. table:: :widths: auto - +--------+-------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_process_modification`\ (\ ) |virtual| | - +--------+-------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process_modification`\ (\ ) |virtual| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -132,6 +134,18 @@ Override this virtual method to implement a custom skeleton modifier. You should \ :ref:`_process_modification` must not apply :ref:`influence` to bone poses because the :ref:`Skeleton3D` automatically applies influence to all bone poses set by the modifier. +.. rst-class:: classref-item-separator + +---- + +.. _class_SkeletonModifier3D_method_get_skeleton: + +.. rst-class:: classref-method + +:ref:`Skeleton3D` **get_skeleton**\ (\ ) |const| :ref:`🔗` + +Get parent :ref:`Skeleton3D` node if found. + .. |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_tilemap.rst b/classes/class_tilemap.rst index 3fb76661e5a..bc63e741979 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -308,9 +308,9 @@ Show or hide the TileMap's navigation meshes. If set to :ref:`VISIBILITY_MODE_DE - |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_rendering_quadrant_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 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 quadrant 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. +The quadrant size does not apply on Y-sorted layers, as tiles are 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. diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst index 8b34c69a80e..62145b9fa45 100644 --- a/classes/class_tilemaplayer.rst +++ b/classes/class_tilemaplayer.rst @@ -52,6 +52,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`use_kinematic_bodies` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`x_draw_order_reversed` | ``false`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`y_sort_origin` | ``0`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ @@ -284,9 +286,9 @@ Show or hide the **TileMapLayer**'s navigation meshes. If set to :ref:`DEBUG_VIS - |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_rendering_quadrant_size**\ (\ ) -The **TileMapLayer**'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 **TileMapLayer**'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 quadrant size groups together ``16 * 16 = 256`` tiles. -The quadrant size does not apply on a Y-sorted **TileMapLayer**, as tiles are be grouped by Y position instead in that case. +The quadrant size does not apply on a Y-sorted **TileMapLayer**, as tiles are 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 **TileMapLayer**'s local coordinate system. @@ -347,6 +349,23 @@ If ``true``, this **TileMapLayer** collision shapes will be instantiated as kine ---- +.. _class_TileMapLayer_property_x_draw_order_reversed: + +.. rst-class:: classref-property + +:ref:`bool` **x_draw_order_reversed** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_x_draw_order_reversed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_x_draw_order_reversed**\ (\ ) + +If :ref:`CanvasItem.y_sort_enabled` is enabled, setting this to ``true`` will reverse the order the tiles are drawn on the X-axis. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMapLayer_property_y_sort_origin: .. rst-class:: classref-property