diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 041f71a42..6d91468fe 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -788,6 +788,10 @@ The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter, but value Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. +\ **Note:** As annotations describe their subject, the :ref:`@static_unload` annotation must be placed before the class definition and inheritance. + +\ **Warning:** Currently, due to a bug, scripts are never freed, even if :ref:`@static_unload` annotation is used. + .. rst-class:: classref-item-separator ---- @@ -877,6 +881,8 @@ An optional ``message`` can be shown in addition to the generic "Assertion faile assert(speed >= 0 and speed < 20) # You can also combine the two conditional statements in one check. assert(speed < 20, "the speed limit is 20") # Show a message. +\ **Note:** :ref:`assert` is a keyword, not a function. So you cannot access it as a :ref:`Callable` or use it inside expressions. + .. rst-class:: classref-item-separator ---- @@ -955,7 +961,7 @@ Returns an array of dictionaries representing the current call stack. See also : Starting from ``_ready()``, ``bar()`` would print: -.. code:: +.. code:: text [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] @@ -987,7 +993,7 @@ Returns the passed ``instance`` converted to a Dictionary. Can be useful for ser Prints out: -.. code:: +.. code:: text [@subpath, @path, foo] [, res://test.gd, bar] @@ -1010,7 +1016,7 @@ Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value mus - A :ref:`Script` (you can use any class, including inner one). -Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays) and is more performant. Use the operator instead of this method if you do not need dynamic type checking. +Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need dynamic type checking. Examples: @@ -1091,6 +1097,8 @@ Returns a :ref:`Resource` from the filesystem located at ``path` # Create instance of a scene. var diamond = preload("res://diamond.tscn").instantiate() +\ **Note:** :ref:`preload` is a keyword, not a function. So you cannot access it as a :ref:`Callable`. + .. rst-class:: classref-item-separator ---- @@ -1105,7 +1113,7 @@ Like :ref:`@GlobalScope.print`, but includes th The output in the console may look like the following: -.. code:: +.. code:: text Test print At: res://test.gd:15:_process() @@ -1126,7 +1134,7 @@ Prints a stack trace at the current code location. See also :ref:`get_stack` backwards, use: Output: -.. code:: +.. code:: text 9 6 @@ -1190,7 +1198,7 @@ To iterate over :ref:`float`, convert them in the loop. Output: -.. code:: +.. code:: text 0.3 0.2 diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 4dded3653..282efd7fd 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -6849,7 +6849,7 @@ For complex use cases where multiple ranges are needed, consider using :ref:`Cur :ref:`int` **rid_allocate_id**\ (\ ) -Allocates a unique ID which can be used by the implementation to construct a RID. This is used mainly from native extensions to implement servers. +Allocates a unique ID which can be used by the implementation to construct an RID. This is used mainly from native extensions to implement servers. .. rst-class:: classref-item-separator @@ -6861,7 +6861,7 @@ Allocates a unique ID which can be used by the implementation to construct a RID :ref:`RID` **rid_from_int64**\ (\ base\: :ref:`int`\ ) -Creates a RID from a ``base``. This is used mainly from native extensions to build servers. +Creates an RID from a ``base``. This is used mainly from native extensions to build servers. .. rst-class:: classref-item-separator diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index a3c3bf190..98cde8d74 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -72,9 +72,9 @@ Methods +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Button` | :ref:`get_ok_button`\ (\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_text_enter`\ (\ line_edit\: :ref:`Control`\ ) | + | |void| | :ref:`register_text_enter`\ (\ line_edit\: :ref:`LineEdit`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_button`\ (\ button\: :ref:`Control`\ ) | + | |void| | :ref:`remove_button`\ (\ button\: :ref:`Button`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -295,7 +295,7 @@ Returns the OK :ref:`Button` instance. .. rst-class:: classref-method -|void| **register_text_enter**\ (\ line_edit\: :ref:`Control`\ ) +|void| **register_text_enter**\ (\ line_edit\: :ref:`LineEdit`\ ) Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. @@ -307,7 +307,7 @@ Registers a :ref:`LineEdit` in the dialog. When the enter key is .. rst-class:: classref-method -|void| **remove_button**\ (\ button\: :ref:`Control`\ ) +|void| **remove_button**\ (\ button\: :ref:`Button`\ ) Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``button`` must be a :ref:`Button` added with :ref:`add_button` or :ref:`add_cancel_button` method. After removal, pressing the ``button`` will no longer emit this dialog's :ref:`custom_action` or :ref:`canceled` signals. diff --git a/classes/class_array.rst b/classes/class_array.rst index 842fc9eec..d907755b9 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -501,6 +501,12 @@ Returns the last element of the array. Prints an error and returns ``null`` if t Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. +:: + + var array = ["a", "b", "c", "c", "d", "e"] + print(array.bsearch("c", true)) # Prints 2, at the first matching element. + print(array.bsearch("c", false)) # Prints 4, after the last matching element, pointing to "d". + \ **Note:** Calling :ref:`bsearch` on an unsorted array results in unexpected behavior. .. rst-class:: classref-item-separator @@ -515,6 +521,8 @@ Finds the index of an existing value (or the insertion index that maintains sort Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. +\ **Note:** The custom method must accept the two arguments in any order, you cannot rely on that the first argument will always be from the array. + \ **Note:** Calling :ref:`bsearch_custom` on an unsorted array results in unexpected behavior. .. rst-class:: classref-item-separator diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index e79c0a38e..b8905fb4b 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -234,7 +234,7 @@ The ``arrays`` argument is an array of arrays. Each of the :ref:`Mesh.ARRAY_MAX< The ``blend_shapes`` argument is an array of vertex data for each blend shape. Each element is an array of the same structure as ``arrays``, but :ref:`Mesh.ARRAY_VERTEX`, :ref:`Mesh.ARRAY_NORMAL`, and :ref:`Mesh.ARRAY_TANGENT` are set if and only if they are set in ``arrays`` and all other entries are ``null``. -The ``lods`` argument is a dictionary with :ref:`float` keys and :ref:`PackedInt32Array` values. Each entry in the dictionary represents a LOD level of the surface, where the value is the :ref:`Mesh.ARRAY_INDEX` array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of a LOD also increases the distance that the objects has to be from the camera before the LOD is used. +The ``lods`` argument is a dictionary with :ref:`float` keys and :ref:`PackedInt32Array` values. Each entry in the dictionary represents an LOD level of the surface, where the value is the :ref:`Mesh.ARRAY_INDEX` array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used. The ``flags`` argument is the bitwise or of, as required: One value of :ref:`ArrayCustomFormat` left shifted by ``ARRAY_FORMAT_CUSTOMn_SHIFT`` for each custom channel in use, :ref:`Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE`, :ref:`Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS`, or :ref:`Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY`. diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 5f2ed4b47..3a3bf0495 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -12,7 +12,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamGenerator`, :ref:`AudioStreamMicrophone`, :ref:`AudioStreamMP3`, :ref:`AudioStreamOggVorbis`, :ref:`AudioStreamPolyphonic`, :ref:`AudioStreamRandomizer`, :ref:`AudioStreamWAV` +**Inherited By:** :ref:`AudioStreamGenerator`, :ref:`AudioStreamInteractive`, :ref:`AudioStreamMicrophone`, :ref:`AudioStreamMP3`, :ref:`AudioStreamOggVorbis`, :ref:`AudioStreamPlaylist`, :ref:`AudioStreamPolyphonic`, :ref:`AudioStreamRandomizer`, :ref:`AudioStreamSynchronized`, :ref:`AudioStreamWAV` Base class for audio streams. diff --git a/classes/class_audiostreaminteractive.rst b/classes/class_audiostreaminteractive.rst new file mode 100644 index 000000000..a96c8b7f7 --- /dev/null +++ b/classes/class_audiostreaminteractive.rst @@ -0,0 +1,555 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamInteractive.xml. + +.. _class_AudioStreamInteractive: + +AudioStreamInteractive +====================== + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Audio stream that can playback music interactively, combining clips and a transition table. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This is an audio stream that can playback music interactively, combining clips and a transition table. Clips must be added first, and the transition rules via the :ref:`add_transition`. Additionally, this stream export a property parameter to control the playback via :ref:`AudioStreamPlayer`, :ref:`AudioStreamPlayer2D`, or :ref:`AudioStreamPlayer3D`. + +The way this is used is by filling a number of clips, then configuring the transition table. From there, clips are selected for playback and the music will smoothly go from the current to the new one while using the corresponding transition rule defined in the transition table. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------+-------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`clip_count` | ``0`` | + +-----------------------+-------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`initial_clip` | ``0`` | + +-----------------------+-------------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_transition`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`, from_time\: :ref:`TransitionFromTime`, to_time\: :ref:`TransitionToTime`, fade_mode\: :ref:`FadeMode`, fade_beats\: :ref:`float`, use_filler_clip\: :ref:`bool` = false, filler_clip\: :ref:`int` = -1, hold_previous\: :ref:`bool` = false\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_transition`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoAdvanceMode` | :ref:`get_clip_auto_advance`\ (\ clip_index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_clip_auto_advance_next_clip`\ (\ clip_index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_clip_name`\ (\ clip_index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStream` | :ref:`get_clip_stream`\ (\ clip_index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_transition_fade_beats`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FadeMode` | :ref:`get_transition_fade_mode`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_transition_filler_clip`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransitionFromTime` | :ref:`get_transition_from_time`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_transition_list`\ (\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransitionToTime` | :ref:`get_transition_to_time`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_transition`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_transition_holding_previous`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_transition_using_filler_clip`\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_clip_auto_advance`\ (\ clip_index\: :ref:`int`, mode\: :ref:`AutoAdvanceMode`\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_clip_auto_advance_next_clip`\ (\ clip_index\: :ref:`int`, auto_advance_next_clip\: :ref:`int`\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_clip_name`\ (\ clip_index\: :ref:`int`, name\: :ref:`StringName`\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_clip_stream`\ (\ clip_index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) | + +---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_AudioStreamInteractive_TransitionFromTime: + +.. rst-class:: classref-enumeration + +enum **TransitionFromTime**: + +.. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_IMMEDIATE: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionFromTime` **TRANSITION_FROM_TIME_IMMEDIATE** = ``0`` + +Start transition as soon as possible, don't wait for any specific time position. + +.. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_NEXT_BEAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionFromTime` **TRANSITION_FROM_TIME_NEXT_BEAT** = ``1`` + +Transition when the clip playback position reaches the next beat. + +.. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_NEXT_BAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionFromTime` **TRANSITION_FROM_TIME_NEXT_BAR** = ``2`` + +Transition when the clip playback position reaches the next bar. + +.. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_END: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionFromTime` **TRANSITION_FROM_TIME_END** = ``3`` + +Transition when the current clip finished playing. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_AudioStreamInteractive_TransitionToTime: + +.. rst-class:: classref-enumeration + +enum **TransitionToTime**: + +.. _class_AudioStreamInteractive_constant_TRANSITION_TO_TIME_SAME_POSITION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionToTime` **TRANSITION_TO_TIME_SAME_POSITION** = ``0`` + +Transition to the same position in the destination clip. This is useful when both clips have exactly the same length and the music should fade between them. + +.. _class_AudioStreamInteractive_constant_TRANSITION_TO_TIME_START: + +.. rst-class:: classref-enumeration-constant + +:ref:`TransitionToTime` **TRANSITION_TO_TIME_START** = ``1`` + +Transition to the start of the destination clip. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_AudioStreamInteractive_FadeMode: + +.. rst-class:: classref-enumeration + +enum **FadeMode**: + +.. _class_AudioStreamInteractive_constant_FADE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`FadeMode` **FADE_DISABLED** = ``0`` + +Do not use fade for the transition. This is useful when transitioning from a clip-end to clip-beginning, and each clip has their begin/end. + +.. _class_AudioStreamInteractive_constant_FADE_IN: + +.. rst-class:: classref-enumeration-constant + +:ref:`FadeMode` **FADE_IN** = ``1`` + +Use a fade-in in the next clip, let the current clip finish. + +.. _class_AudioStreamInteractive_constant_FADE_OUT: + +.. rst-class:: classref-enumeration-constant + +:ref:`FadeMode` **FADE_OUT** = ``2`` + +Use a fade-out in the current clip, the next clip will start by itself. + +.. _class_AudioStreamInteractive_constant_FADE_CROSS: + +.. rst-class:: classref-enumeration-constant + +:ref:`FadeMode` **FADE_CROSS** = ``3`` + +Use a cross-fade between clips. + +.. _class_AudioStreamInteractive_constant_FADE_AUTOMATIC: + +.. rst-class:: classref-enumeration-constant + +:ref:`FadeMode` **FADE_AUTOMATIC** = ``4`` + +Use automatic fade logic depending on the transition from/to. It is recommended to use this by default. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_AudioStreamInteractive_AutoAdvanceMode: + +.. rst-class:: classref-enumeration + +enum **AutoAdvanceMode**: + +.. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoAdvanceMode` **AUTO_ADVANCE_DISABLED** = ``0`` + +Disable auto-advance (default). + +.. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoAdvanceMode` **AUTO_ADVANCE_ENABLED** = ``1`` + +Enable auto-advance, a clip must be specified. + +.. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_RETURN_TO_HOLD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoAdvanceMode` **AUTO_ADVANCE_RETURN_TO_HOLD** = ``2`` + +Enable auto-advance, but instead of specifying a clip, the playback will return to hold (see :ref:`add_transition`). + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Constants +--------- + +.. _class_AudioStreamInteractive_constant_CLIP_ANY: + +.. rst-class:: classref-constant + +**CLIP_ANY** = ``-1`` + +This constant describes that any clip is valid for a specific transition as either source or destination. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_AudioStreamInteractive_property_clip_count: + +.. rst-class:: classref-property + +:ref:`int` **clip_count** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_clip_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_clip_count**\ (\ ) + +Amount of clips contained in this interactive player. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_property_initial_clip: + +.. rst-class:: classref-property + +:ref:`int` **initial_clip** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_initial_clip**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_initial_clip**\ (\ ) + +Index of the initial clip, which will be played first when this stream is played. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_AudioStreamInteractive_method_add_transition: + +.. rst-class:: classref-method + +|void| **add_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`, from_time\: :ref:`TransitionFromTime`, to_time\: :ref:`TransitionToTime`, fade_mode\: :ref:`FadeMode`, fade_beats\: :ref:`float`, use_filler_clip\: :ref:`bool` = false, filler_clip\: :ref:`int` = -1, hold_previous\: :ref:`bool` = false\ ) + +Add a transition between two clips. Provide the indices of the source and destination clips, or use the :ref:`CLIP_ANY` constant to indicate that transition happens to/from any clip to this one. + +\* ``from_time`` indicates the moment in the current clip the transition will begin after triggered. + +\* ``to_time`` indicates the time in the next clip that the playback will start from. + +\* ``fade_mode`` indicates how the fade will happen between clips. If unsure, just use :ref:`FADE_AUTOMATIC` which uses the most common type of fade for each situation. + +\* ``fade_beats`` indicates how many beats the fade will take. Using decimals is allowed. + +\* ``use_filler_clip`` indicates that there will be a filler clip used between the source and destination clips. + +\* ``filler_clip`` the index of the filler clip. + +\* If ``hold_previous`` is used, then this clip will be remembered. This can be used together with :ref:`AUTO_ADVANCE_RETURN_TO_HOLD` to return to this clip after another is done playing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_erase_transition: + +.. rst-class:: classref-method + +|void| **erase_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) + +Erase a transition by providing ``from_clip`` and ``to_clip`` clip indices. :ref:`CLIP_ANY` can be used for either argument or both. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_clip_auto_advance: + +.. rst-class:: classref-method + +:ref:`AutoAdvanceMode` **get_clip_auto_advance**\ (\ clip_index\: :ref:`int`\ ) |const| + +Return whether a clip has auto-advance enabled. See :ref:`set_clip_auto_advance`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_clip_auto_advance_next_clip: + +.. rst-class:: classref-method + +:ref:`int` **get_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`\ ) |const| + +Return the clip towards which the clip referenced by ``clip_index`` will auto-advance to. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_clip_name: + +.. rst-class:: classref-method + +:ref:`StringName` **get_clip_name**\ (\ clip_index\: :ref:`int`\ ) |const| + +Return the name of a clip. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_clip_stream: + +.. rst-class:: classref-method + +:ref:`AudioStream` **get_clip_stream**\ (\ clip_index\: :ref:`int`\ ) |const| + +Return the :ref:`AudioStream` associated with a clip. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_fade_beats: + +.. rst-class:: classref-method + +:ref:`float` **get_transition_fade_beats**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return the time (in beats) for a transition (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_fade_mode: + +.. rst-class:: classref-method + +:ref:`FadeMode` **get_transition_fade_mode**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return the mode for a transition (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_filler_clip: + +.. rst-class:: classref-method + +:ref:`int` **get_transition_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return the filler clip for a transition (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_from_time: + +.. rst-class:: classref-method + +:ref:`TransitionFromTime` **get_transition_from_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return the source time position for a transition (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_list: + +.. rst-class:: classref-method + +:ref:`PackedInt32Array` **get_transition_list**\ (\ ) |const| + +Return the list of transitions (from, to interleaved). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_get_transition_to_time: + +.. rst-class:: classref-method + +:ref:`TransitionToTime` **get_transition_to_time**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return the destination time position for a transition (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_has_transition: + +.. rst-class:: classref-method + +:ref:`bool` **has_transition**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return true if a given transition exists (was added via :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_is_transition_holding_previous: + +.. rst-class:: classref-method + +:ref:`bool` **is_transition_holding_previous**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return whether a transition uses the *hold previous* functionality (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_is_transition_using_filler_clip: + +.. rst-class:: classref-method + +:ref:`bool` **is_transition_using_filler_clip**\ (\ from_clip\: :ref:`int`, to_clip\: :ref:`int`\ ) |const| + +Return whether a transition uses the *filler clip* functionality (see :ref:`add_transition`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_set_clip_auto_advance: + +.. rst-class:: classref-method + +|void| **set_clip_auto_advance**\ (\ clip_index\: :ref:`int`, mode\: :ref:`AutoAdvanceMode`\ ) + +Set whether a clip will auto-advance by changing the auto-advance mode. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_set_clip_auto_advance_next_clip: + +.. rst-class:: classref-method + +|void| **set_clip_auto_advance_next_clip**\ (\ clip_index\: :ref:`int`, auto_advance_next_clip\: :ref:`int`\ ) + +Set the index of the next clip towards which this clip will auto advance to when finished. If the clip being played loops, then auto-advance will be ignored. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_set_clip_name: + +.. rst-class:: classref-method + +|void| **set_clip_name**\ (\ clip_index\: :ref:`int`, name\: :ref:`StringName`\ ) + +Set the name of the current clip (for easier identification). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamInteractive_method_set_clip_stream: + +.. rst-class:: classref-method + +|void| **set_clip_stream**\ (\ clip_index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) + +Set the :ref:`AudioStream` associated with the current clip. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index ebde6a874..95e9be4a9 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -12,7 +12,7 @@ AudioStreamPlayback **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamPlaybackPolyphonic`, :ref:`AudioStreamPlaybackResampled` +**Inherited By:** :ref:`AudioStreamPlaybackInteractive`, :ref:`AudioStreamPlaybackPlaylist`, :ref:`AudioStreamPlaybackPolyphonic`, :ref:`AudioStreamPlaybackResampled`, :ref:`AudioStreamPlaybackSynchronized` Meta class for playing back audio. diff --git a/classes/class_audiostreamplaybackinteractive.rst b/classes/class_audiostreamplaybackinteractive.rst new file mode 100644 index 000000000..52af6b026 --- /dev/null +++ b/classes/class_audiostreamplaybackinteractive.rst @@ -0,0 +1,74 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackInteractive.xml. + +.. _class_AudioStreamPlaybackInteractive: + +AudioStreamPlaybackInteractive +============================== + +**Inherits:** :ref:`AudioStreamPlayback` **<** :ref:`RefCounted` **<** :ref:`Object` + +Playback component of :ref:`AudioStreamInteractive`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Playback component of :ref:`AudioStreamInteractive`. Contains functions to change the currently played clip. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`switch_to_clip`\ (\ clip_index\: :ref:`int`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`switch_to_clip_by_name`\ (\ clip_name\: :ref:`StringName`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_AudioStreamPlaybackInteractive_method_switch_to_clip: + +.. rst-class:: classref-method + +|void| **switch_to_clip**\ (\ clip_index\: :ref:`int`\ ) + +Switch to a clip (by index). + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaybackInteractive_method_switch_to_clip_by_name: + +.. rst-class:: classref-method + +|void| **switch_to_clip_by_name**\ (\ clip_name\: :ref:`StringName`\ ) + +Switch to a clip (by name). + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaybackplaylist.rst b/classes/class_audiostreamplaybackplaylist.rst new file mode 100644 index 000000000..6c5a3c836 --- /dev/null +++ b/classes/class_audiostreamplaybackplaylist.rst @@ -0,0 +1,24 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackPlaylist.xml. + +.. _class_AudioStreamPlaybackPlaylist: + +AudioStreamPlaybackPlaylist +=========================== + +**Inherits:** :ref:`AudioStreamPlayback` **<** :ref:`RefCounted` **<** :ref:`Object` + +Playback class used for :ref:`AudioStreamPlaylist`. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaybacksynchronized.rst b/classes/class_audiostreamplaybacksynchronized.rst new file mode 100644 index 000000000..d0703335a --- /dev/null +++ b/classes/class_audiostreamplaybacksynchronized.rst @@ -0,0 +1,26 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaybackSynchronized.xml. + +.. _class_AudioStreamPlaybackSynchronized: + +AudioStreamPlaybackSynchronized +=============================== + +**Inherits:** :ref:`AudioStreamPlayback` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaylist.rst b/classes/class_audiostreamplaylist.rst new file mode 100644 index 000000000..a303dec54 --- /dev/null +++ b/classes/class_audiostreamplaylist.rst @@ -0,0 +1,189 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamPlaylist.xml. + +.. _class_AudioStreamPlaylist: + +AudioStreamPlaylist +=================== + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +:ref:`AudioStream` that includes sub-streams and plays them back like a playslit. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+----------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`fade_time` | ``0.3`` | + +---------------------------+----------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`loop` | ``true`` | + +---------------------------+----------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`shuffle` | ``false`` | + +---------------------------+----------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`stream_count` | ``0`` | + +---------------------------+----------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_bpm`\ (\ ) |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStream` | :ref:`get_list_stream`\ (\ stream_index\: :ref:`int`\ ) |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_list_stream`\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Constants +--------- + +.. _class_AudioStreamPlaylist_constant_MAX_STREAMS: + +.. rst-class:: classref-constant + +**MAX_STREAMS** = ``64`` + +Maximum amount of streams supported in the playlist. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_AudioStreamPlaylist_property_fade_time: + +.. rst-class:: classref-property + +:ref:`float` **fade_time** = ``0.3`` + +.. rst-class:: classref-property-setget + +- |void| **set_fade_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fade_time**\ (\ ) + +Fade time used when a stream ends, when going to the next one. Streams are expected to have an extra bit of audio after the end to help with fading. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaylist_property_loop: + +.. rst-class:: classref-property + +:ref:`bool` **loop** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) + +If true, the playlist will loop, otherwise the playlist when end when the last stream is played. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaylist_property_shuffle: + +.. rst-class:: classref-property + +:ref:`bool` **shuffle** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_shuffle**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_shuffle**\ (\ ) + +Shuffle the playlist. Streams are played in random order. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaylist_property_stream_count: + +.. rst-class:: classref-property + +:ref:`int` **stream_count** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_stream_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stream_count**\ (\ ) + +Amount of streams in the playlist. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_AudioStreamPlaylist_method_get_bpm: + +.. rst-class:: classref-method + +:ref:`float` **get_bpm**\ (\ ) |const| + +Return the bpm of the playlist, which can vary depending on the clip being played. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaylist_method_get_list_stream: + +.. rst-class:: classref-method + +:ref:`AudioStream` **get_list_stream**\ (\ stream_index\: :ref:`int`\ ) |const| + +Get the stream at playback position index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamPlaylist_method_set_list_stream: + +.. rst-class:: classref-method + +|void| **set_list_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) + +Set the stream at playback position index. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamsynchronized.rst b/classes/class_audiostreamsynchronized.rst new file mode 100644 index 000000000..40018eb9d --- /dev/null +++ b/classes/class_audiostreamsynchronized.rst @@ -0,0 +1,153 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamSynchronized.xml. + +.. _class_AudioStreamSynchronized: + +AudioStreamSynchronized +======================= + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Stream that can be fitted with sub-streams, which will be played in-sync. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This is a stream that can be fitted with sub-streams, which will be played in-sync. The streams being at exactly the same time when play is pressed, and will end when the last of them ends. If one of the sub-streams loops, then playback will continue. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------+--------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`stream_count` | ``0`` | + +-----------------------+--------------------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStream` | :ref:`get_sync_stream`\ (\ stream_index\: :ref:`int`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_sync_stream_volume`\ (\ stream_index\: :ref:`int`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sync_stream`\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sync_stream_volume`\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Constants +--------- + +.. _class_AudioStreamSynchronized_constant_MAX_STREAMS: + +.. rst-class:: classref-constant + +**MAX_STREAMS** = ``32`` + +Maximum amount of streams that can be synchrohized. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_AudioStreamSynchronized_property_stream_count: + +.. rst-class:: classref-property + +:ref:`int` **stream_count** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_stream_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stream_count**\ (\ ) + +Set the total amount of streams that will be played back synchronized. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_AudioStreamSynchronized_method_get_sync_stream: + +.. rst-class:: classref-method + +:ref:`AudioStream` **get_sync_stream**\ (\ stream_index\: :ref:`int`\ ) |const| + +Get one of the synchronized streams, by index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamSynchronized_method_get_sync_stream_volume: + +.. rst-class:: classref-method + +:ref:`float` **get_sync_stream_volume**\ (\ stream_index\: :ref:`int`\ ) |const| + +Get the volume of one of the synchronized streams, by index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamSynchronized_method_set_sync_stream: + +.. rst-class:: classref-method + +|void| **set_sync_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) + +Set one of the synchronized streams, by index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioStreamSynchronized_method_set_sync_stream_volume: + +.. rst-class:: classref-method + +|void| **set_sync_stream_volume**\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) + +Set the volume of one of the synchronized streams, by index. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 0d26b3e85..02b66aabb 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -129,6 +129,8 @@ Methods +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Callable` | :ref:`create`\ (\ variant\: :ref:`Variant`, method\: :ref:`StringName`\ ) |static| | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_argument_count`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_bound_arguments`\ (\ ) |const| | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bound_arguments_count`\ (\ ) |const| | @@ -317,6 +319,18 @@ Creates a new **Callable** for the method named ``method`` in the specified ``va ---- +.. _class_Callable_method_get_argument_count: + +.. rst-class:: classref-method + +:ref:`int` **get_argument_count**\ (\ ) |const| + +Returns the total number of arguments this **Callable** should take, including optional arguments. This means that any arguments bound with :ref:`bind` are *subtracted* from the result, and any arguments unbound with :ref:`unbind` are *added* to the result. + +.. rst-class:: classref-item-separator + +---- + .. _class_Callable_method_get_bound_arguments: .. rst-class:: classref-method diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index e0e2ebfdf..c86a6dbea 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -29,53 +29,55 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_exists`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_enum_constants`\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_enum_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`class_get_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`class_get_integer_constant_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_integer_constant_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_method_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`class_get_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_property_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`class_get_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_signal_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_method`\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`class_set_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_class_list`\ (\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_inheriters_from_class`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_parent_class`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class_enabled`\ (\ class\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_parent_class`\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_exists`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_enum_constants`\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_enum_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`class_get_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`class_get_integer_constant_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_integer_constant_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`class_get_method_argument_count`\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_method_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`class_get_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_property_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`class_get_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_signal_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_method`\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`class_set_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_class_list`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_inheriters_from_class`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_parent_class`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class_enabled`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_parent_class`\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -170,6 +172,18 @@ Returns an array with the names all the integer constants of ``class`` or its an ---- +.. _class_ClassDB_method_class_get_method_argument_count: + +.. rst-class:: classref-method + +:ref:`int` **class_get_method_argument_count**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| + +Returns the number of arguments of the method ``method`` of ``class`` or its ancestry if ``no_inheritance`` is ``false``. + +.. rst-class:: classref-item-separator + +---- + .. _class_ClassDB_method_class_get_method_list: .. rst-class:: classref-method diff --git a/classes/class_color.rst b/classes/class_color.rst index ab3fd2977..9398c1b77 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -1757,7 +1757,7 @@ Constructs a color from an `OK HSL profile ` **from_rgbe9995**\ (\ rgbe\: :ref:`int`\ ) |static| -Decodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995`. +Decodes a **Color** from an RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995`. .. rst-class:: classref-item-separator diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index 8c109cc45..d176c3f01 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -203,7 +203,7 @@ Generates an RSA :ref:`CryptoKey` that can be used for creating Generates a self-signed :ref:`X509Certificate` from the given :ref:`CryptoKey` and ``issuer_name``. The certificate validity will be defined by ``not_before`` and ``not_after`` (first valid date and last valid date). The ``issuer_name`` must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). -A small example to generate an RSA key and a X509 self-signed certificate. +A small example to generate an RSA key and an X509 self-signed certificate. .. tabs:: diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index bad2fd705..4107f7b05 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -351,7 +351,7 @@ If ``true`` enables :ref:`GDExtension` support for this web b If ``true``, the exported game will support threads. It requires `a "cross-origin isolated" website `__, which may be difficult to set up and is limited for security reasons (such as not being able to communicate with third-party websites). -If ``false``, the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on a HTTPS website. +If ``false``, the exported game will not support threads. As a result, it is more prone to performance and audio issues, but will only require to be run on an HTTPS website. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 7612df8fa..c4df64af2 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -58,619 +58,621 @@ Properties .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debugger/auto_switch_to_remote_scene_tree` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debugger/profile_native_calls` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debugger/profiler_frame_max_functions` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debugger/remote_inspect_refresh_interval` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debugger/remote_scene_tree_refresh_interval` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/filesystem/always_show_folders` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`docks/filesystem/textfile_extensions` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`docks/filesystem/thumbnail_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`docks/property_editor/auto_refresh_interval` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/auto_expand_to_selected` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/start_create_dialog_fully_expanded` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_color1` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_color2` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_ik_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_outline_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/2d/bone_outline_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_selected_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/2d/bone_width` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/grid_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/guides_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/viewport_border_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_fov` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_z_far` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_z_near` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/freelook/freelook_activation_modifier` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_base_speed` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_inertia` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/freelook/freelook_navigation_scheme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_sensitivity` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/freelook/freelook_speed_zoom_link` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/grid_division_level_bias` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_division_level_max` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_division_level_min` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_xy_plane` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_xz_plane` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_yz_plane` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/emulate_3_button_mouse` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/emulate_numpad` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/invert_x_axis` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/invert_y_axis` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/navigation_scheme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/orbit_modifier` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/pan_modifier` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/warped_mouse_panning` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/zoom_modifier` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/zoom_style` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_inertia` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_sensitivity` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/translation_inertia` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/zoom_inertia` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/primary_grid_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/primary_grid_steps` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/secondary_grid_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/selection_box_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/shape` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/grid_map/pick_distance` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/2d_editor_pan_speed` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/2d_editor_panning_scheme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/animation_editors_panning_scheme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/panning/simple_panning` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/sub_editors_panning_scheme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/polygon_editor/auto_bake_delay` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/polygon_editor/show_previous_outline` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/shader_editor/behavior/files/restore_shaders_on_load` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/tiles_editor/display_grid` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/tiles_editor/grid_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/color_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/conditional_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/input_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/output_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/particle_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/scalar_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/special_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/textures_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/transform_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/utility_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/category_colors/vector_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`editors/visual_editors/color_theme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/boolean_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/sampler_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/scalar_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/transform_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector2_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector3_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector4_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/visual_editors/grid_pattern` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/visual_editors/lines_curvature` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/visual_editors/minimap_opacity` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/visual_editors/visual_shader/port_preview_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/directories/autoscan_project_path` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/directories/default_project_path` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/3d_model_editor` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/audio_editor` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/raster_image_editor` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator_flags` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/vector_image_editor` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/file_dialog/display_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/file_dialog/show_hidden_files` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/import/blender/blender_path` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/import/fbx2gltf/fbx2gltf_path` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/code_font_contextual_ligatures` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font_custom_opentype_features` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font_custom_variations` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/code_font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/editor/custom_display_scale` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/debug/enable_pseudolocalization` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/display_scale` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/editor_language` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/editor_screen` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/expand_to_title` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_antialiasing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_hinting` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_subpixel_positioning` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/localize_settings` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/low_processor_mode_sleep_usec` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/main_font` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/main_font_bold` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/main_font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/mouse_extra_buttons_navigate_history` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/project_manager_screen` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/save_on_focus_loss` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/separate_distraction_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/show_internal_errors_in_toast_notifications` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/show_update_spinner` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/single_window_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/update_continuously` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/vsync_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/inspector/default_color_picker_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/inspector/default_color_picker_shape` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/inspector/default_float_step` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/inspector/default_property_name_style` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/disable_folding` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/horizontal_vector2_editing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/horizontal_vector_types_editing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/open_resources_in_current_inspector` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`interface/inspector/resources_to_open_in_new_inspector` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/show_low_level_opentype_features` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/enable` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/maximize_window` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/restore_windows_on_load` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/scene_tabs/display_close_button` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/scene_tabs/maximum_width` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/scene_tabs/restore_scenes_on_load` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/scene_tabs/show_script_button` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/scene_tabs/show_thumbnail_on_hover` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`interface/theme/accent_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/additional_spacing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`interface/theme/base_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/base_spacing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/border_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/contrast` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/corner_radius` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/custom_theme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/theme/draw_extra_borders` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/theme/follow_system_theme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/icon_and_font_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/icon_saturation` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/preset` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/relationship_line_opacity` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/spacing_preset` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/theme/use_system_accent_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/enable_long_press_as_right_click` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/connection/network_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/debug/remote_host` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/debug/remote_port` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/http_proxy/host` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/http_proxy/port` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/tls/editor_tls_certificates` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`project_manager/default_renderer` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`project_manager/directory_naming_convention` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`project_manager/sorting_order` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/auto_save/save_before_running` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_close_output_on_stop` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_open_output_on_play` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/output/font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/platforms/linuxbsd/prefer_wayland` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/android_window` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/rect` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`run/window_placement/rect_custom_position` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/screen` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/caret_blink` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_interval` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_all_occurrences` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_current_line` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/caret/type` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/guidelines/show_line_length_guidelines` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/highlight_type_safe_lines` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/line_numbers_zero_padded` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_info_gutter` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_line_numbers` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/lines/autowrap_mode` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/lines/code_folding` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/lines/word_wrap` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/minimap/minimap_width` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/minimap/show_minimap` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_spaces` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_tabs` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/whitespace/line_spacing` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_scripts_on_external_change` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/files/autosave_interval_secs` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/trim_trailing_whitespace_on_save` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/indent/auto_indent` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/indent/indent_wrapped_lines` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/indent/size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/indent/type` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/drag_and_drop_selection` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/move_caret_on_right_click` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/scroll_past_end_of_file` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/smooth_scrolling` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/stay_in_script_editor_on_node_selected` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/navigation/v_scroll_speed` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/add_type_hints` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/auto_brace_complete` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/completion/code_complete_delay` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/code_complete_enabled` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/colorize_suggestions` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/complete_file_paths` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/completion/idle_parse_delay` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/put_callhint_tooltip_below_current_line` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/use_single_quotes` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_source_font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_title_font_size` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/help/show_help_index` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/script_list/show_members_overview` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/script_list/sort_members_outline_alphabetically` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`text_editor/theme/color_theme` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/background_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/base_type_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/bookmark_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/brace_mismatch_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/breakpoint_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_background_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/code_folding_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_background_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_existing_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_font_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_hovered_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_selected_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/control_flow_keyword_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/current_line_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/doc_comment_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/engine_type_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/executing_line_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/folded_code_region_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/function_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/keyword_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_length_guideline_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_number_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/mark_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/member_variable_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/number_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/safe_line_number_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_border_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/selection_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/string_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/symbol_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_selected_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debugger/auto_switch_to_remote_scene_tree` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debugger/profile_native_calls` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/profiler_frame_max_functions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debugger/remote_inspect_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debugger/remote_scene_tree_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/filesystem/always_show_folders` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`docks/filesystem/textfile_extensions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`docks/filesystem/thumbnail_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`docks/property_editor/auto_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/auto_expand_to_selected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/start_create_dialog_fully_expanded` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_color1` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_color2` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_ik_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_outline_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/2d/bone_outline_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/2d/bone_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/guides_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/viewport_border_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_fov` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_z_far` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_z_near` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/freelook/freelook_activation_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_base_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/freelook/freelook_navigation_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_sensitivity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/freelook/freelook_speed_zoom_link` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/grid_division_level_bias` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_division_level_max` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_division_level_min` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_xy_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_xz_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_yz_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/emulate_3_button_mouse` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/emulate_numpad` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/invert_x_axis` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/invert_y_axis` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/navigation_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/orbit_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/pan_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/warped_mouse_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/zoom_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/zoom_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_sensitivity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/translation_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/zoom_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/primary_grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/primary_grid_steps` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/secondary_grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/selection_box_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/shape` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/grid_map/pick_distance` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/2d_editor_pan_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/2d_editor_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/animation_editors_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/panning/simple_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/sub_editors_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/polygon_editor/auto_bake_delay` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/polygon_editor/show_previous_outline` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/shader_editor/behavior/files/restore_shaders_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/tiles_editor/display_grid` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/tiles_editor/grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/color_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/conditional_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/input_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/output_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/particle_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/scalar_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/special_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/textures_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/transform_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/utility_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/vector_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editors/visual_editors/color_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/boolean_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/sampler_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/scalar_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/transform_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector2_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector3_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector4_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/visual_editors/grid_pattern` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/visual_editors/lines_curvature` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/visual_editors/minimap_opacity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/visual_editors/visual_shader/port_preview_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/directories/autoscan_project_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/directories/default_project_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/3d_model_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/audio_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/raster_image_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator_flags` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/vector_image_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/file_dialog/display_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/file_dialog/show_hidden_files` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/blender/blender_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/fbx2gltf/fbx2gltf_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/code_font_contextual_ligatures` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font_custom_opentype_features` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font_custom_variations` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/code_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/editor/custom_display_scale` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/debug/enable_pseudolocalization` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/display_scale` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/editor_language` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/editor_screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/expand_to_title` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_antialiasing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_hinting` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_subpixel_positioning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/localize_settings` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/low_processor_mode_sleep_usec` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/main_font` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/main_font_bold` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/main_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/mouse_extra_buttons_navigate_history` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/project_manager_screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/save_on_focus_loss` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/separate_distraction_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/show_internal_errors_in_toast_notifications` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/show_update_spinner` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/single_window_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/update_continuously` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/vsync_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_color_picker_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_color_picker_shape` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/inspector/default_float_step` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_property_name_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/disable_folding` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/horizontal_vector2_editing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/horizontal_vector_types_editing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/open_resources_in_current_inspector` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`interface/inspector/resources_to_open_in_new_inspector` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/show_low_level_opentype_features` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/enable` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/maximize_window` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/restore_windows_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/scene_tabs/display_close_button` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/scene_tabs/maximum_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/restore_scenes_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/show_script_button` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/show_thumbnail_on_hover` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`interface/theme/accent_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/additional_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`interface/theme/base_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/base_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/border_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/contrast` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/corner_radius` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/custom_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/draw_extra_borders` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/follow_system_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/icon_and_font_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/icon_saturation` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/preset` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/relationship_line_opacity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/spacing_preset` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/use_system_accent_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_long_press_as_right_click` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/connection/network_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/debug/remote_host` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/debug/remote_port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/http_proxy/host` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/http_proxy/port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/tls/editor_tls_certificates` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`project_manager/default_renderer` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`project_manager/directory_naming_convention` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`project_manager/sorting_order` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/auto_save/save_before_running` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_close_output_on_stop` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_open_output_on_play` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/output/font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/platforms/linuxbsd/prefer_wayland` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/android_window` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/rect` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`run/window_placement/rect_custom_position` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/caret_blink` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_all_occurrences` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_current_line` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/caret/type` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/guidelines/show_line_length_guidelines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/highlight_type_safe_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/line_numbers_zero_padded` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_info_gutter` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_line_numbers` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/lines/autowrap_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/lines/code_folding` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/lines/word_wrap` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/minimap/minimap_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/minimap/show_minimap` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_spaces` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_tabs` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/whitespace/line_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_scripts_on_external_change` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/files/autosave_interval_secs` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/trim_trailing_whitespace_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/indent/auto_indent` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/indent/indent_wrapped_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/indent/size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/indent/type` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/drag_and_drop_selection` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/move_caret_on_right_click` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/scroll_past_end_of_file` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/smooth_scrolling` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/stay_in_script_editor_on_node_selected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/navigation/v_scroll_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/add_type_hints` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/auto_brace_complete` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/completion/code_complete_delay` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/code_complete_enabled` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/colorize_suggestions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/complete_file_paths` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/completion/idle_parse_delay` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/put_callhint_tooltip_below_current_line` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/use_single_quotes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_source_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_title_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/help/show_help_index` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/show_members_overview` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/sort_members_outline_alphabetically` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/theme/color_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/base_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/bookmark_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/brace_mismatch_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/breakpoint_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/code_folding_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_existing_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_font_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_hovered_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/control_flow_keyword_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/current_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/doc_comment_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/engine_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/executing_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/folded_code_region_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/function_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/keyword_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_length_guideline_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/mark_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/member_variable_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/safe_line_number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_border_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/selection_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/string_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/symbol_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -3903,6 +3905,18 @@ If ``true``, the caret will be moved when right-clicking somewhere in the script ---- +.. _class_EditorSettings_property_text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method** + +If ``true``, opens the script editor when connecting a signal to an existing script method from the Node dock. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/navigation/scroll_past_end_of_file: .. rst-class:: classref-property diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 8ab8d2d7e..58908cd58 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -129,7 +129,7 @@ Limiting the FPS can be useful to reduce the host machine's power consumption, w If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled** or **Adaptive**, the setting takes precedence and the max FPS number cannot exceed the monitor's refresh rate. -If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled**, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using a FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. +If :ref:`ProjectSettings.display/window/vsync/vsync_mode` is **Enabled**, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. See also :ref:`physics_ticks_per_second` and :ref:`ProjectSettings.application/run/max_fps`. @@ -280,7 +280,7 @@ To detect whether the current build is 64-bit, you can use the fact that all 64- -\ **Note:** This method does *not* return the name of the system's CPU architecture (like :ref:`OS.get_processor_name`). For example, when running a ``x86_32`` Godot binary on a ``x86_64`` system, the returned value will still be ``"x86_32"``. +\ **Note:** This method does *not* return the name of the system's CPU architecture (like :ref:`OS.get_processor_name`). For example, when running an ``x86_32`` Godot binary on an ``x86_64`` system, the returned value will still be ``"x86_32"``. .. rst-class:: classref-item-separator diff --git a/classes/class_environment.rst b/classes/class_environment.rst index e7b8ab033..b0eadbef8 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -2060,7 +2060,7 @@ The default exposure used for tonemapping. Higher values result in a brighter im - |void| **set_tonemapper**\ (\ value\: :ref:`ToneMapper`\ ) - :ref:`ToneMapper` **get_tonemapper**\ (\ ) -The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on a LDR display. (Godot doesn't support rendering on HDR displays yet.) +The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on an LDR display. (Godot doesn't support rendering on HDR displays yet.) .. rst-class:: classref-item-separator diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index b08859808..979fa7a7d 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -840,7 +840,7 @@ Returns the next bits from the file as a floating-point number. :ref:`String` **get_sha256**\ (\ path\: :ref:`String`\ ) |static| -Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. +Returns an SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. .. rst-class:: classref-item-separator diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index 2865ec0ed..10bd5bfd1 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -78,6 +78,8 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`data` | ``PackedByteArray()`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`disable_embedded_bitmaps` | ``true`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`fixed_size` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`FixedSizeScaleMode` | :ref:`fixed_size_scale_mode` | ``0`` | @@ -315,6 +317,23 @@ Contents of the dynamic font source file. ---- +.. _class_FontFile_property_disable_embedded_bitmaps: + +.. rst-class:: classref-property + +:ref:`bool` **disable_embedded_bitmaps** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_disable_embedded_bitmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_disable_embedded_bitmaps**\ (\ ) + +If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). + +.. rst-class:: classref-item-separator + +---- + .. _class_FontFile_property_fixed_size: .. rst-class:: classref-property @@ -614,7 +633,7 @@ Removes all font cache entries. |void| **clear_glyphs**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) -Removes all rendered glyphs information from the cache entry. +Removes all rendered glyph information from the cache entry. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`remove_texture` to remove them manually. @@ -1398,7 +1417,7 @@ Sets array containing glyph packing data. |void| **set_transform**\ (\ cache_index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) -Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. +Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 0025cd3f5..1d8484eba 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -40,17 +40,19 @@ Properties .. table:: :widths: auto - +-------------------------+---------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`buffer` | ``-1`` | - +-------------------------+---------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`byte_length` | ``0`` | - +-------------------------+---------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`byte_offset` | ``0`` | - +-------------------------+---------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`byte_stride` | ``-1`` | - +-------------------------+---------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`indices` | ``false`` | - +-------------------------+---------------------------------------------------------------+-----------+ + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`buffer` | ``-1`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`byte_length` | ``0`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`byte_offset` | ``0`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`byte_stride` | ``-1`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`indices` | ``false`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`vertex_attributes` | ``false`` | + +-------------------------+---------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -152,7 +154,24 @@ The stride, in bytes, between interleaved data. If ``-1``, this buffer view is n - |void| **set_indices**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_indices**\ (\ ) -True if the GLTFBufferView's OpenGL GPU buffer type is an ``ELEMENT_ARRAY_BUFFER`` used for vertex indices (integer constant ``34963``). False if the buffer type is ``ARRAY_BUFFER`` used for vertex attributes (integer constant ``34962``) or when any other value. See `Buffers, BufferViews, and Accessors `__ for possible values. This property is set but never used, setting this property will do nothing. +True if the GLTFBufferView's OpenGL GPU buffer type is an ``ELEMENT_ARRAY_BUFFER`` used for vertex indices (integer constant ``34963``). False if the buffer type is any other value. See `Buffers, BufferViews, and Accessors `__ for possible values. This property is set on import and used on export. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFBufferView_property_vertex_attributes: + +.. rst-class:: classref-property + +:ref:`bool` **vertex_attributes** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_vertex_attributes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_vertex_attributes**\ (\ ) + +True if the GLTFBufferView's OpenGL GPU buffer type is an ``ARRAY_BUFFER`` used for vertex attributes (integer constant ``34962``). False if the buffer type is any other value. See `Buffers, BufferViews, and Accessors `__ for possible values. This property is set on import and used on export. .. rst-class:: classref-section-separator diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index be8ceb295..69d0ef56b 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -12,7 +12,7 @@ GLTFMesh **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -GLTFMesh represents an GLTF mesh. +GLTFMesh represents a GLTF mesh. .. rst-class:: classref-introduction-group diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index bf9609441..2c5882f7c 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -12,7 +12,7 @@ GLTFTexture **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -GLTFTexture represents a texture in an GLTF file. +GLTFTexture represents a texture in a GLTF file. .. rst-class:: classref-introduction-group diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index e6ccd0ba9..4068e6701 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -34,7 +34,7 @@ The :ref:`HashType` enum shows the supported hashi # Check that file exists. if not FileAccess.file_exists(path): return - # Start a SHA-256 context. + # Start an SHA-256 context. var ctx = HashingContext.new() ctx.start(HashingContext.HASH_SHA256) # Open the file to hash. @@ -58,7 +58,7 @@ The :ref:`HashType` enum shows the supported hashi { return; } - // Start a SHA-256 context. + // Start an SHA-256 context. var ctx = new HashingContext(); ctx.Start(HashingContext.HashType.Sha256); // Open the file to hash. @@ -158,7 +158,7 @@ Closes the current context, and return the computed hash. :ref:`Error` **start**\ (\ type\: :ref:`HashType`\ ) -Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` to start computation of a SHA-256). +Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` to start computation of an SHA-256). .. rst-class:: classref-item-separator diff --git a/classes/class_image.rst b/classes/class_image.rst index e2264e492..979901a50 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -1458,7 +1458,7 @@ Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (* :ref:`Error` **load_svg_from_string**\ (\ svg_str\: :ref:`String`, scale\: :ref:`float` = 1.0\ ) -Loads an image from the string contents of a SVG file (**.svg**). +Loads an image from the string contents of an SVG file (**.svg**). \ **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the ``module_svg_enabled=no`` SCons option. diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 71d118d85..e31833ba6 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -145,7 +145,7 @@ The ``arrays`` argument is an array of arrays. Each of the :ref:`Mesh.ARRAY_MAX< The ``blend_shapes`` argument is an array of vertex data for each blend shape. Each element is an array of the same structure as ``arrays``, but :ref:`Mesh.ARRAY_VERTEX`, :ref:`Mesh.ARRAY_NORMAL`, and :ref:`Mesh.ARRAY_TANGENT` are set if and only if they are set in ``arrays`` and all other entries are ``null``. -The ``lods`` argument is a dictionary with :ref:`float` keys and :ref:`PackedInt32Array` values. Each entry in the dictionary represents a LOD level of the surface, where the value is the :ref:`Mesh.ARRAY_INDEX` array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of a LOD also increases the distance that the objects has to be from the camera before the LOD is used. +The ``lods`` argument is a dictionary with :ref:`float` keys and :ref:`PackedInt32Array` values. Each entry in the dictionary represents an LOD level of the surface, where the value is the :ref:`Mesh.ARRAY_INDEX` array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used. The ``flags`` argument is the bitwise or of, as required: One value of :ref:`ArrayCustomFormat` left shifted by ``ARRAY_FORMAT_CUSTOMn_SHIFT`` for each custom channel in use, :ref:`Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE`, :ref:`Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS`, or :ref:`Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY`. diff --git a/classes/class_input.rst b/classes/class_input.rst index d53d421fd..f691eabe9 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -644,7 +644,7 @@ Returns the current value of the joypad axis at given index (see :ref:`JoyAxis` **get_joy_guid**\ (\ device\: :ref:`int`\ ) |const| -Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database `__ to determine gamepad names and mappings based on this GUID. +Returns an SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database `__ to determine gamepad names and mappings based on this GUID. .. rst-class:: classref-item-separator diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 15390c5fa..8151ce81b 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -110,7 +110,7 @@ Returns ``true`` when using the eraser end of a stylus pen. - |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_position**\ (\ ) -The drag position. +The drag position in the viewport the node is in, using the coordinate system of this viewport. .. rst-class:: classref-item-separator diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index e3459a9ab..ec44a0c5c 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -119,7 +119,7 @@ The touch index in the case of a multi-touch event. One index = one finger. - |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_position**\ (\ ) -The touch position, in screen (global) coordinates. +The touch position in the viewport the node is in, using the coordinate system of this viewport. .. rst-class:: classref-item-separator diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 82bc40124..e0ce1b051 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -257,7 +257,7 @@ Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`multi Returns the sender's peer ID for the RPC currently being executed. -\ **Note:** If not inside an RPC this method will return 0. +\ **Note:** This method returns ``0`` when called outside of an RPC. As such, the original peer ID may be lost when code execution is delayed (such as with GDScript's ``await`` keyword). .. rst-class:: classref-item-separator diff --git a/classes/class_nativemenu.rst b/classes/class_nativemenu.rst index 86b13069c..b2625ccba 100644 --- a/classes/class_nativemenu.rst +++ b/classes/class_nativemenu.rst @@ -21,6 +21,38 @@ Description **NativeMenu** handles low-level access to the OS native global menu bar and popup menus. +\ **Note:** This is low-level API, consider using :ref:`MenuBar` with :ref:`MenuBar.prefer_global_menu` set to ``true``, and :ref:`PopupMenu` with :ref:`PopupMenu.prefer_native_menu` set to ``true``. + +To create a menu, use :ref:`create_menu`, add menu items using ``add_*_item`` methods. To remove a menu, use :ref:`free_menu`. + +:: + + var menu + + func _menu_callback(item_id): + if item_id == "ITEM_CUT": + cut() + elif item_id == "ITEM_COPY": + copy() + elif item_id == "ITEM_PASTE": + paste() + + func _enter_tree(): + # Create new menu and add items: + menu = NativeMenu.create_menu() + NativeMenu.add_item(menu, "Cut", _menu_callback, Callable(), "ITEM_CUT") + NativeMenu.add_item(menu, "Copy", _menu_callback, Callable(), "ITEM_COPY") + NativeMenu.add_separator(menu) + NativeMenu.add_item(menu, "Paste", _menu_callback, Callable(), "ITEM_PASTE") + + func _on_button_pressed(): + # Show popup menu at mouse position: + NativeMenu.popup(menu, DisplayServer.mouse_get_position()) + + func _exit_tree(): + # Remove menu when it's no longer needed: + NativeMenu.free_menu(menu) + .. rst-class:: classref-reftable-group Methods @@ -116,6 +148,8 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_item`\ (\ rid\: :ref:`RID`, idx\: :ref:`int`\ ) | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_interface_direction`\ (\ rid\: :ref:`RID`, is_rtl\: :ref:`bool`\ ) | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_accelerator`\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_callback`\ (\ rid\: :ref:`RID`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | @@ -188,6 +222,30 @@ enum **Feature**: **NativeMenu** supports native popup menus. +.. _class_NativeMenu_constant_FEATURE_OPEN_CLOSE_CALLBACK: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_OPEN_CLOSE_CALLBACK** = ``2`` + +**NativeMenu** supports menu open and close callbacks. + +.. _class_NativeMenu_constant_FEATURE_HOVER_CALLBACK: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_HOVER_CALLBACK** = ``3`` + +**NativeMenu** supports menu item hover callback. + +.. _class_NativeMenu_constant_FEATURE_KEY_CALLBACK: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_KEY_CALLBACK** = ``4`` + +**NativeMenu** supports menu item accelerator/key callback. + .. rst-class:: classref-item-separator ---- @@ -269,7 +327,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -289,7 +349,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -309,7 +371,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -331,7 +395,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -351,7 +417,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -375,7 +443,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -397,7 +467,9 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +\ **Note:** ``accelerator`` and ``key_callback`` are ignored on Windows. .. rst-class:: classref-item-separator @@ -413,7 +485,7 @@ Adds a separator between items to the global menu ``rid``. Separators also occup Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -429,7 +501,7 @@ Adds an item that will act as a submenu of the global menu ``rid``. The ``submen Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -443,7 +515,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde Removes all items from the global menu ``rid``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -457,7 +529,7 @@ Removes all items from the global menu ``rid``. Creates a new global menu object. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -471,7 +543,7 @@ Creates a new global menu object. Returns the index of the item with the specified ``tag``. Index is automatically assigned to each item by the engine. Index can not be set manually. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -485,7 +557,7 @@ Returns the index of the item with the specified ``tag``. Index is automatically Returns the index of the item with the specified ``text``. Index is automatically assigned to each item by the engine. Index can not be set manually. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -499,7 +571,7 @@ Returns the index of the item with the specified ``text``. Index is automaticall Frees a global menu object created by this **NativeMenu**. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -527,7 +599,7 @@ Returns the accelerator of the item at index ``idx``. Accelerators are special c Returns the callback of the item at index ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -541,7 +613,7 @@ Returns the callback of the item at index ``idx``. Returns number of items in the global menu ``rid``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -555,7 +627,7 @@ Returns number of items in the global menu ``rid``. Returns the icon of the item at index ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -597,7 +669,7 @@ Returns the callback of the item accelerator at index ``idx``. Returns number of states of a multistate item. See :ref:`add_multistate_item` for details. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -611,7 +683,7 @@ Returns number of states of a multistate item. See :ref:`add_multistate_item` for details. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -625,7 +697,7 @@ Returns the state of a multistate item. See :ref:`add_multistate_item` for more info on how to add a submenu. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -639,7 +711,7 @@ Returns the submenu ID of the item at index ``idx``. See :ref:`add_submenu_item< Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_tag`, which provides a simple way of assigning context data to items. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -653,7 +725,7 @@ Returns the metadata of the specified item, which might be of any type. You can Returns the text of the item at index ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -723,7 +795,7 @@ b]Note:** This method is implemented only on macOS. Returns global menu size. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -765,7 +837,7 @@ Returns readable name of a special system menu. Returns ``true`` if the specified ``feature`` is supported by the current **NativeMenu**, ``false`` otherwise. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -779,7 +851,7 @@ Returns ``true`` if the specified ``feature`` is supported by the current **Nati Returns ``true`` if ``rid`` is valid global menu. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -807,7 +879,7 @@ Returns ``true`` if a special system menu is supported. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -821,7 +893,7 @@ Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if Returns ``true`` if the item at index ``idx`` is checked. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -837,7 +909,7 @@ Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled i See :ref:`set_item_disabled` for more info on how to disable an item. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -869,7 +941,7 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -897,7 +969,7 @@ Return ``true`` is global menu is a special system menu. Shows the global menu at ``position`` in the screen coordinates. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -913,7 +985,21 @@ Removes the item at index ``idx`` from the global menu ``rid``. \ **Note:** The indices of items after the removed item will be shifted by one. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NativeMenu_method_set_interface_direction: + +.. rst-class:: classref-method + +|void| **set_interface_direction**\ (\ rid\: :ref:`RID`, is_rtl\: :ref:`bool`\ ) + +Sets the menu text layout directtion. + +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -943,7 +1029,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when an item \ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -957,7 +1043,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when an item Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -971,7 +1057,7 @@ Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the ty Sets the checkstate status of the item at index ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -985,7 +1071,7 @@ Sets the checkstate status of the item at index ``idx``. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1029,9 +1115,9 @@ Sets the callback of the item at index ``idx``. The callback is emitted when an Replaces the :ref:`Texture2D` icon of the specified ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. -\ **Note:** This method is not supported by macOS "_dock" menu items. +\ **Note:** This method is not supported by macOS Dock menu items. .. rst-class:: classref-item-separator @@ -1075,7 +1161,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when its acc Sets number of state of a multistate item. See :ref:`add_multistate_item` for details. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1091,7 +1177,7 @@ Sets the type of the item at the specified index ``idx`` to radio button. If ``f \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1105,7 +1191,7 @@ Sets the type of the item at the specified index ``idx`` to radio button. If ``f Sets the state of a multistate item. See :ref:`add_multistate_item` for details. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1119,7 +1205,7 @@ Sets the state of a multistate item. See :ref:`add_multistate_item`, which provides a simple way of assigning context data to items. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1147,7 +1233,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit Sets the text of the item at index ``idx``. -\ **Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented on macOS and Windows. .. rst-class:: classref-item-separator @@ -1189,6 +1275,8 @@ Sets the minimum width of the global menu. Registers callable to emit when the menu is about to show. +\ **Note:** This method is implemented only on macOS. + .. rst-class:: classref-item-separator ---- @@ -1201,6 +1289,8 @@ Registers callable to emit when the menu is about to show. Registers callable to emit when the menu is about to closed. +\ **Note:** This method is implemented only on macOS. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationmeshsourcegeometrydata2d.rst b/classes/class_navigationmeshsourcegeometrydata2d.rst index a064510db..11dce7c5c 100644 --- a/classes/class_navigationmeshsourcegeometrydata2d.rst +++ b/classes/class_navigationmeshsourcegeometrydata2d.rst @@ -34,12 +34,18 @@ Methods +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_obstruction_outline`\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_projected_obstruction`\ (\ vertices\: :ref:`PackedVector2Array`, carve\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_traversable_outline`\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_projected_obstructions`\ (\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`get_obstruction_outlines`\ (\ ) |const| | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_projected_obstructions`\ (\ ) |const| | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`get_traversable_outlines`\ (\ ) |const| | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_data`\ (\ ) | @@ -48,6 +54,8 @@ Methods +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_obstruction_outlines`\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_projected_obstructions`\ (\ projected_obstructions\: :ref:`Array`\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_traversable_outlines`\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) | +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,6 +80,18 @@ Adds the outline points of a shape as obstructed area. ---- +.. _class_NavigationMeshSourceGeometryData2D_method_add_projected_obstruction: + +.. rst-class:: classref-method + +|void| **add_projected_obstruction**\ (\ vertices\: :ref:`PackedVector2Array`, carve\: :ref:`bool`\ ) + +Adds a projected obstruction shape to the source geometry. If ``carve`` is ``true`` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData2D_method_add_traversable_outline: .. rst-class:: classref-method @@ -96,6 +116,18 @@ Clears the internal data. ---- +.. _class_NavigationMeshSourceGeometryData2D_method_clear_projected_obstructions: + +.. rst-class:: classref-method + +|void| **clear_projected_obstructions**\ (\ ) + +Clears all projected obstructions. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData2D_method_get_obstruction_outlines: .. rst-class:: classref-method @@ -108,6 +140,22 @@ Returns all the obstructed area outlines arrays. ---- +.. _class_NavigationMeshSourceGeometryData2D_method_get_projected_obstructions: + +.. rst-class:: classref-method + +:ref:`Array` **get_projected_obstructions**\ (\ ) |const| + +Returns the projected obstructions as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: + +- ``vertices`` - A :ref:`PackedFloat32Array` that defines the outline points of the projected shape. + +- ``carve`` - A :ref:`bool` that defines how the projected shape affects the navigation mesh baking. If ``true`` the projected shape will not be affected by addition offsets, e.g. agent radius. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData2D_method_get_traversable_outlines: .. rst-class:: classref-method @@ -152,6 +200,28 @@ Adds the geometry data of another **NavigationMeshSourceGeometryData2D** to the Sets all the obstructed area outlines arrays. +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData2D_method_set_projected_obstructions: + +.. rst-class:: classref-method + +|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) + +Sets the projected obstructions with an Array of Dictionaries with the following key value pairs: + + +.. tabs:: + + .. code-tab:: gdscript + + "vertices" : PackedFloat32Array + "carve" : bool + + + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_navigationmeshsourcegeometrydata3d.rst b/classes/class_navigationmeshsourcegeometrydata3d.rst index 218f5f156..043b7dfeb 100644 --- a/classes/class_navigationmeshsourcegeometrydata3d.rst +++ b/classes/class_navigationmeshsourcegeometrydata3d.rst @@ -31,27 +31,35 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_faces`\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_mesh`\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_mesh_array`\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_indices`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`get_vertices`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_data`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`merge`\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData3D`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_indices`\ (\ indices\: :ref:`PackedInt32Array`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_vertices`\ (\ vertices\: :ref:`PackedFloat32Array`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_faces`\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_mesh`\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_mesh_array`\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_projected_obstruction`\ (\ vertices\: :ref:`PackedVector3Array`, elevation\: :ref:`float`, height\: :ref:`float`, carve\: :ref:`bool`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_projected_obstructions`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_indices`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_projected_obstructions`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`get_vertices`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_data`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge`\ (\ other_geometry\: :ref:`NavigationMeshSourceGeometryData3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indices`\ (\ indices\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_projected_obstructions`\ (\ projected_obstructions\: :ref:`Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertices`\ (\ vertices\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -98,6 +106,18 @@ Adds an :ref:`Array` the size of :ref:`Mesh.ARRAY_MAX`, elevation\: :ref:`float`, height\: :ref:`float`, carve\: :ref:`bool`\ ) + +Adds a projected obstruction shape to the source geometry. The ``vertices`` are considered projected on a xz-axes plane, placed at the global y-axis ``elevation`` and extruded by ``height``. If ``carve`` is ``true`` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData3D_method_clear: .. rst-class:: classref-method @@ -110,6 +130,18 @@ Clears the internal data. ---- +.. _class_NavigationMeshSourceGeometryData3D_method_clear_projected_obstructions: + +.. rst-class:: classref-method + +|void| **clear_projected_obstructions**\ (\ ) + +Clears all projected obstructions. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData3D_method_get_indices: .. rst-class:: classref-method @@ -122,6 +154,26 @@ Returns the parsed source geometry data indices array. ---- +.. _class_NavigationMeshSourceGeometryData3D_method_get_projected_obstructions: + +.. rst-class:: classref-method + +:ref:`Array` **get_projected_obstructions**\ (\ ) |const| + +Returns the projected obstructions as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: + +- ``vertices`` - A :ref:`PackedFloat32Array` that defines the outline points of the projected shape. + +- ``elevation`` - A :ref:`float` that defines the projected shape placement on the y-axis. + +- ``height`` - A :ref:`float` that defines how much the projected shape is extruded along the y-axis. + +- ``carve`` - A :ref:`bool` that defines how the obstacle affects the navigation mesh baking. If ``true`` the projected shape will not be affected by addition offsets, e.g. agent radius. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationMeshSourceGeometryData3D_method_get_vertices: .. rst-class:: classref-method @@ -168,6 +220,30 @@ Sets the parsed source geometry data indices. The indices need to be matched wit \ **Warning:** Inappropriate data can crash the baking process of the involved third-party libraries. +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationMeshSourceGeometryData3D_method_set_projected_obstructions: + +.. rst-class:: classref-method + +|void| **set_projected_obstructions**\ (\ projected_obstructions\: :ref:`Array`\ ) + +Sets the projected obstructions with an Array of Dictionaries with the following key value pairs: + + +.. tabs:: + + .. code-tab:: gdscript + + "vertices" : PackedFloat32Array + "elevation" : float + "height" : float + "carve" : bool + + + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index ce40dc5ef..9e070561b 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -14,20 +14,18 @@ NavigationObstacle2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -2D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area. +2D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents. .. rst-class:: classref-introduction-group Description ----------- -2D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area. The obstacle needs a navigation map and outline vertices defined to work correctly. +An obstacle needs a navigation map and outline :ref:`vertices` defined to work correctly. The outlines can not cross or overlap. -If the obstacle's vertices are winded in clockwise order, avoidance agents will be pushed in by the obstacle, otherwise, avoidance agents will be pushed out. Outlines must not cross or overlap. +Obstacles can be included in the navigation mesh baking process when :ref:`affect_navigation_mesh` is enabled. They do not add walkable geometry, instead their role is to discard other source geometry inside the shape. This can be used to prevent navigation mesh from appearing in unwanted places. If :ref:`carve_navigation_mesh` is enabled the baked shape will not be affected by offsets of the navigation mesh baking, e.g. the agent radius. -Obstacles are **not** a replacement for a (re)baked navigation mesh. Obstacles **don't** change the resulting path from the pathfinding, obstacles only affect the navigation avoidance agent movement by altering the suggested velocity of the avoidance agent. - -Obstacles using vertices can warp to a new position but should not moved every frame as each move requires a rebuild of the avoidance map. +With :ref:`avoidance_enabled` the obstacle can constrain the avoidance velocities of avoidance using agents. If the obstacle's vertices are wound in clockwise order, avoidance agents will be pushed in by the obstacle, otherwise, avoidance agents will be pushed out. Obstacles using vertices and avoidance can warp to a new position but should not be moved every single frame as each change requires a rebuild of the avoidance map. .. rst-class:: classref-introduction-group @@ -44,17 +42,21 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`avoidance_enabled` | ``true`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`avoidance_layers` | ``1`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`float` | :ref:`radius` | ``0.0`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`Vector2` | :ref:`velocity` | ``Vector2(0, 0)`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`PackedVector2Array` | :ref:`vertices` | ``PackedVector2Array()`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`affect_navigation_mesh` | ``false`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`avoidance_enabled` | ``true`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`avoidance_layers` | ``1`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`carve_navigation_mesh` | ``false`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`radius` | ``0.0`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Vector2` | :ref:`velocity` | ``Vector2(0, 0)`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`PackedVector2Array` | :ref:`vertices` | ``PackedVector2Array()`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group @@ -85,6 +87,23 @@ Methods Property Descriptions --------------------- +.. _class_NavigationObstacle2D_property_affect_navigation_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **affect_navigation_mesh** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_affect_navigation_mesh**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_affect_navigation_mesh**\ (\ ) + +If enabled and parsed in a navigation mesh baking process the obstacle will discard source geometry inside its :ref:`vertices` defined shape. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationObstacle2D_property_avoidance_enabled: .. rst-class:: classref-property @@ -119,6 +138,27 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat ---- +.. _class_NavigationObstacle2D_property_carve_navigation_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **carve_navigation_mesh** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_carve_navigation_mesh**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_carve_navigation_mesh**\ (\ ) + +If enabled the obstacle vertices will carve into the baked navigation mesh with the shape unaffected by additional offsets (e.g. agent radius). + +It will still be affected by further postprocessing of the baking process, like edge and polygon simplification. + +Requires :ref:`affect_navigation_mesh` to be enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationObstacle2D_property_radius: .. rst-class:: classref-property diff --git a/classes/class_navigationobstacle3d.rst b/classes/class_navigationobstacle3d.rst index a1fa2f8a6..d3904f48a 100644 --- a/classes/class_navigationobstacle3d.rst +++ b/classes/class_navigationobstacle3d.rst @@ -14,20 +14,18 @@ NavigationObstacle3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -3D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area. +3D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents. .. rst-class:: classref-introduction-group Description ----------- -3D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area. The obstacle needs a navigation map and outline vertices defined to work correctly. +An obstacle needs a navigation map and outline :ref:`vertices` defined to work correctly. The outlines can not cross or overlap and are restricted to a plane projection. This means the y-axis of the vertices is ignored, instead the obstacle's global y-axis position is used for placement. The projected shape is extruded by the obstacles height along the y-axis. -If the obstacle's vertices are winded in clockwise order, avoidance agents will be pushed in by the obstacle, otherwise, avoidance agents will be pushed out. Outlines must not cross or overlap. +Obstacles can be included in the navigation mesh baking process when :ref:`affect_navigation_mesh` is enabled. They do not add walkable geometry, instead their role is to discard other source geometry inside the shape. This can be used to prevent navigation mesh from appearing in unwanted places, e.g. inside "solid" geometry or on top of it. If :ref:`carve_navigation_mesh` is enabled the baked shape will not be affected by offsets of the navigation mesh baking, e.g. the agent radius. -Obstacles are **not** a replacement for a (re)baked navigation mesh. Obstacles **don't** change the resulting path from the pathfinding, obstacles only affect the navigation avoidance agent movement by altering the suggested velocity of the avoidance agent. - -Obstacles using vertices can warp to a new position but should not moved every frame as each move requires a rebuild of the avoidance map. +With :ref:`avoidance_enabled` the obstacle can constrain the avoidance velocities of avoidance using agents. If the obstacle's vertices are wound in clockwise order, avoidance agents will be pushed in by the obstacle, otherwise, avoidance agents will be pushed out. Obstacles using vertices and avoidance can warp to a new position but should not be moved every single frame as each change requires a rebuild of the avoidance map. .. rst-class:: classref-introduction-group @@ -44,21 +42,25 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`avoidance_enabled` | ``true`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`avoidance_layers` | ``1`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`float` | :ref:`height` | ``1.0`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`float` | :ref:`radius` | ``0.0`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`use_3d_avoidance` | ``false`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`Vector3` | :ref:`velocity` | ``Vector3(0, 0, 0)`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ - | :ref:`PackedVector3Array` | :ref:`vertices` | ``PackedVector3Array()`` | - +-----------------------------------------------------+---------------------------------------------------------------------------------+--------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`affect_navigation_mesh` | ``false`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`avoidance_enabled` | ``true`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`avoidance_layers` | ``1`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`carve_navigation_mesh` | ``false`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`height` | ``1.0`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`radius` | ``0.0`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`use_3d_avoidance` | ``false`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Vector3` | :ref:`velocity` | ``Vector3(0, 0, 0)`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`PackedVector3Array` | :ref:`vertices` | ``PackedVector3Array()`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group @@ -89,6 +91,23 @@ Methods Property Descriptions --------------------- +.. _class_NavigationObstacle3D_property_affect_navigation_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **affect_navigation_mesh** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_affect_navigation_mesh**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_affect_navigation_mesh**\ (\ ) + +If enabled and parsed in a navigation mesh baking process the obstacle will discard source geometry inside its :ref:`vertices` and :ref:`height` defined shape. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationObstacle3D_property_avoidance_enabled: .. rst-class:: classref-property @@ -123,6 +142,27 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat ---- +.. _class_NavigationObstacle3D_property_carve_navigation_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **carve_navigation_mesh** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_carve_navigation_mesh**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_carve_navigation_mesh**\ (\ ) + +If enabled the obstacle vertices will carve into the baked navigation mesh with the shape unaffected by additional offsets (e.g. agent radius). + +It will still be affected by further postprocessing of the baking process, like edge and polygon simplification. + +Requires :ref:`affect_navigation_mesh` to be enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationObstacle3D_property_height: .. rst-class:: classref-property diff --git a/classes/class_object.rst b/classes/class_object.rst index b52fc55c7..8efb61e77 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -121,6 +121,8 @@ Methods +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_meta_list`\ (\ ) |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_method_argument_count`\ (\ method\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_method_list`\ (\ ) |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_property_list`\ (\ ) |const| | @@ -1230,6 +1232,20 @@ Returns the object's metadata entry names as a :ref:`PackedStringArray` **get_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |const| + +Returns the number of arguments of the given ``method`` by name. + +\ **Note:** In C#, ``method`` must be in snake_case when referring to built-in Godot methods. Prefer using the names exposed in the ``MethodName`` class to avoid allocating a new :ref:`StringName` on each call. + +.. rst-class:: classref-item-separator + +---- + .. _class_Object_method_get_method_list: .. rst-class:: classref-method diff --git a/classes/class_openxrextensionwrapperextension.rst b/classes/class_openxrextensionwrapperextension.rst index 7c49ac548..c26df4efb 100644 --- a/classes/class_openxrextensionwrapperextension.rst +++ b/classes/class_openxrextensionwrapperextension.rst @@ -30,7 +30,11 @@ Methods :widths: auto +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer`\ (\ ) |virtual| | + | :ref:`int` | :ref:`_get_composition_layer`\ (\ index\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_count`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -98,9 +102,39 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_composition_layer**\ (\ ) |virtual| +:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| -Returns a pointer to a ``XrCompositionLayerBaseHeader`` struct to provide a composition layer. This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider`. +Returns a pointer to an ``XrCompositionLayerBaseHeader`` struct to provide the given composition layer. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_count: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| + +Returns the number of composition layers this extension wrapper provides via :ref:`_get_composition_layer`. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_order: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| + +Returns an integer that will be used to sort the given composition layer provided via :ref:`_get_composition_layer`. Lower numbers will move the layer to the front of the list, and higher numbers to the end. The default projection layer has an order of ``0``, so layers provided by this method should probably be above or below (but not exactly) ``0``. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider`. .. rst-class:: classref-item-separator diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index d51ca65a8..411df93de 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -48,6 +48,8 @@ Properties +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`item_count` | ``0`` | +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`prefer_native_menu` | ``false`` | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`submenu_popup_delay` | ``0.3`` | +-------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ | :ref:`SystemMenus` | :ref:`system_menu_id` | ``0`` | @@ -428,6 +430,23 @@ The number of items currently in the list. ---- +.. _class_PopupMenu_property_prefer_native_menu: + +.. rst-class:: classref-property + +:ref:`bool` **prefer_native_menu** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_prefer_native_menu**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_prefer_native_menu**\ (\ ) + +If ``true``, :ref:`MenuBar` will use native menu when supported. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_property_submenu_popup_delay: .. rst-class:: classref-property diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 428539ef2..cb1c251bd 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -2090,7 +2090,7 @@ Limiting the FPS can be useful to reduce system power consumption, which reduces If :ref:`display/window/vsync/vsync_mode` is set to ``Enabled`` or ``Adaptive``, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. -If :ref:`display/window/vsync/vsync_mode` is ``Enabled``, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using a FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. +If :ref:`display/window/vsync/vsync_mode` is ``Enabled``, on monitors with variable refresh rate enabled (G-Sync/FreeSync), using an FPS limit a few frames lower than the monitor's refresh rate will `reduce input lag while avoiding tearing `__. If :ref:`display/window/vsync/vsync_mode` is ``Disabled``, limiting the FPS to a high value that can be consistently reached on the system can reduce input lag compared to an uncapped framerate. Since this works by ensuring the GPU load is lower than 100%, this latency reduction is only effective in GPU-bottlenecked scenarios, not CPU-bottlenecked scenarios. @@ -2530,6 +2530,8 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/constant_used_as_function** = ``1`` +**Deprecated:** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. + When set to ``warn`` or ``error``, produces a warning or an error respectively when a constant is used as a function. .. rst-class:: classref-item-separator @@ -2544,6 +2546,8 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w When set to ``warn`` or ``error``, produces a warning or an error respectively when deprecated keywords are used. +\ **Note:** There are currently no deprecated keywords, so this warning is never produced. + .. rst-class:: classref-item-separator ---- @@ -2590,6 +2594,8 @@ If ``true``, scripts in the ``res://addons`` folder will not generate warnings. :ref:`int` **debug/gdscript/warnings/function_used_as_property** = ``1`` +**Deprecated:** This warning is never produced. When a function is used as a property, a :ref:`Callable` is returned. + When set to ``warn`` or ``error``, produces a warning or an error respectively when using a function as if it is a property. .. rst-class:: classref-item-separator @@ -2724,6 +2730,8 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/property_used_as_function** = ``1`` +**Deprecated:** This warning is never produced. Instead, an error is generated if the expression type is known at compile time. + When set to ``warn`` or ``error``, produces a warning or an error respectively when using a property as if it is a function. .. rst-class:: classref-item-separator @@ -3014,7 +3022,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w :ref:`int` **debug/gdscript/warnings/unused_signal** = ``1`` -When set to ``warn`` or ``error``, produces a warning or an error respectively when a signal is declared but never emitted. +When set to ``warn`` or ``error``, produces a warning or an error respectively when a signal is declared but never explicitly used in the class. .. rst-class:: classref-item-separator @@ -4420,7 +4428,7 @@ The command-line arguments to append to Godot's own command line when running th It is possible to make another executable run Godot by using the ``%command%`` placeholder. The placeholder will be replaced with Godot's own command line. Program-specific arguments should be placed *before* the placeholder, whereas Godot-specific arguments should be placed *after* the placeholder. -For example, this can be used to force the project to run on the dedicated GPU in a NVIDIA Optimus system on Linux: +For example, this can be used to force the project to run on the dedicated GPU in an NVIDIA Optimus system on Linux: :: @@ -4528,7 +4536,7 @@ Override for :ref:`filesystem/import/blender/enabled`. +This requires configuring a path to an FBX2glTF executable in the editor settings at :ref:`EditorSettings.filesystem/import/fbx2gltf/fbx2gltf_path`. .. rst-class:: classref-item-separator diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 8498461d0..3a0f4eae9 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -335,6 +335,8 @@ Returns whether or not the specified layer of the :ref:`collision_mask` is ``true``. +\ **Note:** Check that :ref:`is_colliding` returns ``true`` before calling this method to ensure the returned normal is valid and up-to-date. + .. rst-class:: classref-item-separator ---- @@ -345,9 +347,9 @@ Returns the normal of the intersecting object's shape at the collision point, or :ref:`Vector2` **get_collision_point**\ (\ ) |const| -Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. +Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. -\ **Note:** This point is in the **global** coordinate system. +\ **Note:** Check that :ref:`is_colliding` returns ``true`` before calling this method to ensure the returned point is valid and up-to-date. .. rst-class:: classref-item-separator diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 9b67b0719..87feae909 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -410,6 +410,8 @@ Returns whether or not the specified layer of the :ref:`collision_mask` is ``true``. +\ **Note:** Check that :ref:`is_colliding` returns ``true`` before calling this method to ensure the returned normal is valid and up-to-date. + .. rst-class:: classref-item-separator ---- @@ -420,9 +422,9 @@ Returns the normal of the intersecting object's shape at the collision point, or :ref:`Vector3` **get_collision_point**\ (\ ) |const| -Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. +Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. -\ **Note:** This point is in the **global** coordinate system. +\ **Note:** Check that :ref:`is_colliding` returns ``true`` before calling this method to ensure the returned point is valid and up-to-date. .. rst-class:: classref-item-separator diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 8495c3549..b73a753b9 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -11568,7 +11568,7 @@ If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`Pr |void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) -If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be a ``RGBA16`` framebuffer, while when using the Mobile renderer it will be a ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. +If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. \ **Note:** This setting will have no effect when using the GL Compatibility renderer as the GL Compatibility renderer always renders in low dynamic range for performance reasons. diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 1ce20bfc5..8b4103bfc 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -47,6 +47,8 @@ Properties +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`compress` | ``true`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`disable_embedded_bitmaps` | ``true`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Array` | :ref:`fallbacks` | ``[]`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`force_autohinter` | ``false`` | @@ -127,6 +129,18 @@ If ``true``, uses lossless compression for the resulting font. ---- +.. _class_ResourceImporterDynamicFont_property_disable_embedded_bitmaps: + +.. rst-class:: classref-property + +:ref:`bool` **disable_embedded_bitmaps** = ``true`` + +If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterDynamicFont_property_fallbacks: .. rst-class:: classref-property diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst index 36d7bc9f4..919b2f8dd 100644 --- a/classes/class_resourceimportermp3.rst +++ b/classes/class_resourceimportermp3.rst @@ -12,7 +12,7 @@ ResourceImporterMP3 **Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` -Imports a MP3 audio file for playback. +Imports an MP3 audio file for playback. .. rst-class:: classref-introduction-group @@ -21,7 +21,7 @@ Description MP3 is a lossy audio format, with worse audio quality compared to :ref:`ResourceImporterOggVorbis` at a given bitrate. -In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using a MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression. +In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using an MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression. MP3 requires more CPU to decode than :ref:`ResourceImporterWAV`. If you need to play a lot of simultaneous sounds, it's recommended to use WAV for those sounds instead, especially if targeting low-end devices. diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index 78dfc1c5c..db1720f0a 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -21,7 +21,7 @@ Description Ogg Vorbis is a lossy audio format, with better audio quality compared to :ref:`ResourceImporterMP3` at a given bitrate. -In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using a MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression. +In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using an MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression. Ogg Vorbis requires more CPU to decode than :ref:`ResourceImporterWAV`. If you need to play a lot of simultaneous sounds, it's recommended to use WAV for those sounds instead, especially if targeting low-end devices. diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index 07c2d80ef..ceca4119e 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -24,77 +24,79 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_instantiate`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_editor_can_reload_from_file`\ (\ ) |virtual| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`_get_base_script`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_class_icon_path`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_constants`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_documentation`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_global_name`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_instance_base_type`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptLanguage` | :ref:`_get_language`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_member_line`\ (\ member\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`StringName`\] | :ref:`_get_members`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_method_info`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_rpc_config`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_method_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_property_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_signal_list`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_source_code`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_script_signal`\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_source_code`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_static_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_inherits_script`\ (\ script\: :ref:`Script`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``void*`` | :ref:`_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_instance_has`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_abstract`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_tool`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid`\ (\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_placeholder_erased`\ (\ placeholder\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ``void*`` | :ref:`_placeholder_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_reload`\ (\ keep_state\: :ref:`bool`\ ) |virtual| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_set_source_code`\ (\ code\: :ref:`String`\ ) |virtual| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_update_exports`\ (\ ) |virtual| | - +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_instantiate`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_editor_can_reload_from_file`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`_get_base_script`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_class_icon_path`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_constants`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_documentation`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_global_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_instance_base_type`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptLanguage` | :ref:`_get_language`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_member_line`\ (\ member\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`_get_members`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_method_info`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_rpc_config`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_script_method_argument_count`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_method_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_property_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_signal_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_source_code`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_script_signal`\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_source_code`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_static_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_inherits_script`\ (\ script\: :ref:`Script`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_instance_has`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_abstract`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_tool`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_placeholder_erased`\ (\ placeholder\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_placeholder_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_reload`\ (\ keep_state\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_source_code`\ (\ code\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update_exports`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -301,6 +303,18 @@ Method Descriptions ---- +.. _class_ScriptExtension_private_method__get_script_method_argument_count: + +.. rst-class:: classref-method + +:ref:`Variant` **_get_script_method_argument_count**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| + +Return the expected argument count for the given ``method``, or ``null`` if it can't be determined (which will then fall back to the default behavior). + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptExtension_private_method__get_script_method_list: .. rst-class:: classref-method diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index c135c29b7..ce3104e5e 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -401,7 +401,7 @@ Removes the index array by expanding the vertex array. **Deprecated:** This method is unused internally, as it does not preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods` instead. -Generates a LOD for a given ``nd_threshold`` in linear units (square root of quadric error metric), using at most ``target_index_count`` indices. +Generates an LOD for a given ``nd_threshold`` in linear units (square root of quadric error metric), using at most ``target_index_count`` indices. .. rst-class:: classref-item-separator diff --git a/classes/class_systemfont.rst b/classes/class_systemfont.rst index 75caadcbe..81de38285 100644 --- a/classes/class_systemfont.rst +++ b/classes/class_systemfont.rst @@ -42,6 +42,8 @@ Properties +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`FontAntialiasing` | :ref:`antialiasing` | ``1`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`disable_embedded_bitmaps` | ``true`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`font_italic` | ``false`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`PackedStringArray` | :ref:`font_names` | ``PackedStringArray()`` | @@ -110,6 +112,23 @@ Font anti-aliasing mode. ---- +.. _class_SystemFont_property_disable_embedded_bitmaps: + +.. rst-class:: classref-property + +:ref:`bool` **disable_embedded_bitmaps** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_disable_embedded_bitmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_disable_embedded_bitmaps**\ (\ ) + +If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). + +.. rst-class:: classref-item-separator + +---- + .. _class_SystemFont_property_font_italic: .. rst-class:: classref-property diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 76d65a94a..9e01fdfd3 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -62,6 +62,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |const| | @@ -194,6 +196,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) | @@ -358,6 +362,10 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |const| | @@ -1575,7 +1583,7 @@ Creates a new variation existing font which is reusing the same glyph cache and :ref:`RID` **create_shaped_text**\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) -Creates new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid` method. +Creates a new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid` method. \ **Note:** Direction is ignored if server does not support :ref:`FEATURE_BIDI_LAYOUT` feature (supported by :ref:`TextServerAdvanced`). @@ -1603,7 +1611,7 @@ Draws box displaying character hexadecimal code. Used for replacing missing char |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) -Removes all rendered glyphs information from the cache entry. +Removes all rendered glyph information from the cache entry. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`font_remove_texture` to remove them manually. @@ -1741,6 +1749,18 @@ Returns the font descent (number of pixels below the baseline). ---- +.. _class_TextServer_method_font_get_disable_embedded_bitmaps: + +.. rst-class:: classref-method + +:ref:`bool` **font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| + +Returns whether the font's embedded bitmap loading is disabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_get_embolden: .. rst-class:: classref-method @@ -2549,6 +2569,18 @@ Sets the font descent (number of pixels below the baseline). ---- +.. _class_TextServer_method_font_set_disable_embedded_bitmaps: + +.. rst-class:: classref-method + +|void| **font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) + +If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_set_embolden: .. rst-class:: classref-method @@ -2925,7 +2957,7 @@ Sets array containing glyph packing data. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) -Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. +Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``. @@ -3193,7 +3225,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). :ref:`int` **name_to_tag**\ (\ name\: :ref:`String`\ ) |const| -Converts readable feature, variation, script or language name to OpenType tag. +Converts readable feature, variation, script, or language name to OpenType tag. .. rst-class:: classref-item-separator @@ -3279,7 +3311,7 @@ Returns text span metadata. |void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) -Changes text span font, font size and OpenType features, without changing the text. +Changes text span font, font size, and OpenType features, without changing the text. .. rst-class:: classref-item-separator @@ -3577,6 +3609,30 @@ Breaks text to the lines and columns. Returns character ranges for each segment. ---- +.. _class_TextServer_method_shaped_text_get_object_glyph: + +.. rst-class:: classref-method + +:ref:`int` **shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| + +Returns the glyph index of the inline object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_text_get_object_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| + +Returns the character range of the inline object. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_text_get_object_rect: .. rst-class:: classref-method @@ -4134,7 +4190,7 @@ Strips diacritics from the string. :ref:`String` **tag_to_name**\ (\ tag\: :ref:`int`\ ) |const| -Converts OpenType tag to readable feature, variation, script or language name. +Converts OpenType tag to readable feature, variation, script, or language name. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 7721d4167..8b90346d1 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -64,6 +64,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | @@ -198,6 +200,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_disable_embedded_bitmaps`\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| | @@ -272,7 +276,7 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_format_number`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + | :ref:`String` | :ref:`_format_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -300,7 +304,7 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_name_to_tag`\ (\ name\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_parse_number`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + | :ref:`String` | :ref:`_parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`_parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -362,6 +366,10 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_object_glyph`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_text_get_object_range`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`_shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`_shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | @@ -468,9 +476,9 @@ Method Descriptions |void| **_cleanup**\ (\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method is called before text server is unregistered. .. rst-class:: classref-item-separator @@ -482,9 +490,9 @@ Method Descriptions :ref:`RID` **_create_font**\ (\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Creates a new, empty font cache entry resource. .. rst-class:: classref-item-separator @@ -496,9 +504,9 @@ Method Descriptions :ref:`RID` **_create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +Optional, implement if font supports extra spacing or baseline offset. - There is currently no description for this method. Please help us by :ref:`contributing one `! +Creates a new variation existing font which is reusing the same glyph cache and font data. .. rst-class:: classref-item-separator @@ -510,9 +518,9 @@ Method Descriptions :ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Creates a new buffer for complex text layout, with the given ``direction`` and ``orientation``. .. rst-class:: classref-item-separator @@ -524,9 +532,9 @@ Method Descriptions |void| **_draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draws box displaying character hexadecimal code. .. rst-class:: classref-item-separator @@ -538,9 +546,9 @@ Method Descriptions |void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes all rendered glyph information from the cache entry. .. rst-class:: classref-item-separator @@ -552,9 +560,9 @@ Method Descriptions |void| **_font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes all kerning overrides. .. rst-class:: classref-item-separator @@ -566,9 +574,9 @@ Method Descriptions |void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes all font sizes from the cache entry. .. rst-class:: classref-item-separator @@ -580,9 +588,9 @@ Method Descriptions |void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes all textures from font cache entry. .. rst-class:: classref-item-separator @@ -594,9 +602,9 @@ Method Descriptions |void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``. .. rst-class:: classref-item-separator @@ -608,9 +616,9 @@ Method Descriptions |void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``. .. rst-class:: classref-item-separator @@ -622,9 +630,9 @@ Method Descriptions :ref:`FontAntialiasing` **_font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font anti-aliasing mode. .. rst-class:: classref-item-separator @@ -636,9 +644,9 @@ Method Descriptions :ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-item-separator @@ -650,9 +658,9 @@ Method Descriptions :ref:`float` **_font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-item-separator @@ -664,9 +672,9 @@ Method Descriptions :ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. .. rst-class:: classref-item-separator @@ -678,9 +686,23 @@ Method Descriptions :ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the font descent (number of pixels below the baseline). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__font_get_disable_embedded_bitmaps: + +.. rst-class:: classref-method + +:ref:`bool` **_font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| + +**Optional.**\ + +Returns whether the font's embedded bitmap loading is disabled. .. rst-class:: classref-item-separator @@ -692,9 +714,9 @@ Method Descriptions :ref:`float` **_font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font embolden strength. .. rst-class:: classref-item-separator @@ -706,9 +728,9 @@ Method Descriptions :ref:`int` **_font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-item-separator @@ -720,9 +742,9 @@ Method Descriptions :ref:`int` **_font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-item-separator @@ -734,9 +756,9 @@ Method Descriptions :ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns bitmap font fixed size. .. rst-class:: classref-item-separator @@ -748,9 +770,9 @@ Method Descriptions :ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns bitmap font scaling mode. .. rst-class:: classref-item-separator @@ -762,9 +784,9 @@ Method Descriptions :ref:`bool` **_font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if font texture mipmap generation is enabled. .. rst-class:: classref-item-separator @@ -776,9 +798,9 @@ Method Descriptions :ref:`float` **_font_get_global_oversampling**\ (\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the font oversampling factor, shared by all fonts in the TextServer. .. rst-class:: classref-item-separator @@ -790,9 +812,9 @@ Method Descriptions :ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns glyph advance (offset of the next glyph). .. rst-class:: classref-item-separator @@ -804,9 +826,9 @@ Method Descriptions :ref:`Dictionary` **_font_get_glyph_contours**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns outline contours of the glyph. .. rst-class:: classref-item-separator @@ -818,9 +840,9 @@ Method Descriptions :ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. .. rst-class:: classref-item-separator @@ -832,9 +854,9 @@ Method Descriptions :ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-item-separator @@ -846,9 +868,9 @@ Method Descriptions :ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns glyph offset from the baseline. .. rst-class:: classref-item-separator @@ -860,9 +882,9 @@ Method Descriptions :ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns size of the glyph. .. rst-class:: classref-item-separator @@ -874,9 +896,9 @@ Method Descriptions :ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns index of the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -888,9 +910,9 @@ Method Descriptions :ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns resource ID of the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -902,9 +924,9 @@ Method Descriptions :ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns size of the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -916,9 +938,9 @@ Method Descriptions :ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -930,9 +952,9 @@ Method Descriptions :ref:`Hinting` **_font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-item-separator @@ -944,9 +966,9 @@ Method Descriptions :ref:`Vector2` **_font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns kerning for the pair of glyphs. .. rst-class:: classref-item-separator @@ -958,9 +980,9 @@ Method Descriptions :ref:`Array`\[:ref:`Vector2i`\] **_font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns list of the kerning overrides. .. rst-class:: classref-item-separator @@ -972,9 +994,9 @@ Method Descriptions :ref:`bool` **_font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-item-separator @@ -986,9 +1008,9 @@ Method Descriptions :ref:`PackedStringArray` **_font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns list of language support overrides. .. rst-class:: classref-item-separator @@ -1000,9 +1022,9 @@ Method Descriptions :ref:`int` **_font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the width of the range around the shape between the minimum and maximum representable signed distance. .. rst-class:: classref-item-separator @@ -1014,9 +1036,9 @@ Method Descriptions :ref:`int` **_font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns source font size used to generate MSDF textures. .. rst-class:: classref-item-separator @@ -1028,9 +1050,9 @@ Method Descriptions :ref:`String` **_font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font family name. .. rst-class:: classref-item-separator @@ -1042,9 +1064,9 @@ Method Descriptions :ref:`Dictionary` **_font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font OpenType feature set override. .. rst-class:: classref-item-separator @@ -1056,9 +1078,9 @@ Method Descriptions :ref:`Dictionary` **_font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns :ref:`Dictionary` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). .. rst-class:: classref-item-separator @@ -1070,9 +1092,9 @@ Method Descriptions :ref:`float` **_font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. .. rst-class:: classref-item-separator @@ -1084,9 +1106,9 @@ Method Descriptions :ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns scaling factor of the color bitmap font. .. rst-class:: classref-item-separator @@ -1098,9 +1120,9 @@ Method Descriptions :ref:`bool` **_font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-item-separator @@ -1112,9 +1134,9 @@ Method Descriptions :ref:`PackedStringArray` **_font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns list of script support overrides. .. rst-class:: classref-item-separator @@ -1126,9 +1148,9 @@ Method Descriptions :ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` with font size and outline size. .. rst-class:: classref-item-separator @@ -1140,9 +1162,9 @@ Method Descriptions :ref:`int` **_font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the spacing for ``spacing`` (see :ref:`SpacingType`) in pixels (not relative to the font size). .. rst-class:: classref-item-separator @@ -1154,9 +1176,9 @@ Method Descriptions :ref:`int` **_font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. .. rst-class:: classref-item-separator @@ -1168,9 +1190,9 @@ Method Descriptions |bitfield|\[:ref:`FontStyle`\] **_font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-item-separator @@ -1182,9 +1204,9 @@ Method Descriptions :ref:`String` **_font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font style name. .. rst-class:: classref-item-separator @@ -1196,9 +1218,9 @@ Method Descriptions :ref:`SubpixelPositioning` **_font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font subpixel glyph positioning mode. .. rst-class:: classref-item-separator @@ -1210,9 +1232,9 @@ Method Descriptions :ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns a string containing all the characters available in the font. .. rst-class:: classref-item-separator @@ -1224,9 +1246,9 @@ Method Descriptions :ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns number of textures used by font cache entry. .. rst-class:: classref-item-separator @@ -1238,9 +1260,9 @@ Method Descriptions :ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns font cache texture image data. .. rst-class:: classref-item-separator @@ -1252,9 +1274,9 @@ Method Descriptions :ref:`PackedInt32Array` **_font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns array containing glyph packing data. .. rst-class:: classref-item-separator @@ -1266,9 +1288,9 @@ Method Descriptions :ref:`Transform2D` **_font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns 2D transform applied to the font outlines. .. rst-class:: classref-item-separator @@ -1280,9 +1302,9 @@ Method Descriptions :ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns pixel offset of the underline below the baseline. .. rst-class:: classref-item-separator @@ -1294,9 +1316,9 @@ Method Descriptions :ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns thickness of the underline in pixels. .. rst-class:: classref-item-separator @@ -1308,9 +1330,9 @@ Method Descriptions :ref:`Dictionary` **_font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns variation coordinates for the specified font cache entry. .. rst-class:: classref-item-separator @@ -1322,9 +1344,9 @@ Method Descriptions :ref:`int` **_font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. .. rst-class:: classref-item-separator @@ -1336,9 +1358,9 @@ Method Descriptions :ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-item-separator @@ -1350,9 +1372,9 @@ Method Descriptions :ref:`bool` **_font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if system fonts can be automatically used as fallbacks. .. rst-class:: classref-item-separator @@ -1364,9 +1386,9 @@ Method Descriptions :ref:`bool` **_font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. .. rst-class:: classref-item-separator @@ -1378,9 +1400,9 @@ Method Descriptions :ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true``, if font supports given language (`ISO 639 `__ code). .. rst-class:: classref-item-separator @@ -1392,9 +1414,9 @@ Method Descriptions :ref:`bool` **_font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. .. rst-class:: classref-item-separator @@ -1406,9 +1428,9 @@ Method Descriptions :ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true``, if font supports given script (ISO 15924 code). .. rst-class:: classref-item-separator @@ -1420,9 +1442,9 @@ Method Descriptions |void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-item-separator @@ -1434,9 +1456,9 @@ Method Descriptions |void| **_font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes kerning override for the pair of glyphs. .. rst-class:: classref-item-separator @@ -1448,9 +1470,9 @@ Method Descriptions |void| **_font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Remove language support override. .. rst-class:: classref-item-separator @@ -1462,9 +1484,9 @@ Method Descriptions |void| **_font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes script support override. .. rst-class:: classref-item-separator @@ -1476,9 +1498,9 @@ Method Descriptions |void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes specified font size from the cache entry. .. rst-class:: classref-item-separator @@ -1490,9 +1512,9 @@ Method Descriptions |void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Removes specified texture from the cache entry. .. rst-class:: classref-item-separator @@ -1504,9 +1526,9 @@ Method Descriptions |void| **_font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Renders specified glyph to the font cache texture. .. rst-class:: classref-item-separator @@ -1518,9 +1540,9 @@ Method Descriptions |void| **_font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Renders the range of characters to the font cache texture. .. rst-class:: classref-item-separator @@ -1532,9 +1554,9 @@ Method Descriptions |void| **_font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-item-separator @@ -1546,9 +1568,9 @@ Method Descriptions |void| **_font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font anti-aliasing mode. .. rst-class:: classref-item-separator @@ -1560,9 +1582,9 @@ Method Descriptions |void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-item-separator @@ -1574,9 +1596,9 @@ Method Descriptions |void| **_font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-item-separator @@ -1588,9 +1610,9 @@ Method Descriptions |void| **_font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font source data, e.g contents of the dynamic font source file. .. rst-class:: classref-item-separator @@ -1602,9 +1624,9 @@ Method Descriptions |void| **_font_set_data_ptr**\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets pointer to the font source data, e.g contents of the dynamic font source file. .. rst-class:: classref-item-separator @@ -1616,9 +1638,23 @@ Method Descriptions |void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the font descent (number of pixels below the baseline). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__font_set_disable_embedded_bitmaps: + +.. rst-class:: classref-method + +|void| **_font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID`, disable_embedded_bitmaps\: :ref:`bool`\ ) |virtual| + +**Optional.**\ + +If set to ``true``, embedded font bitmap loading is disabled. .. rst-class:: classref-item-separator @@ -1630,9 +1666,7 @@ Method Descriptions |void| **_font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. .. rst-class:: classref-item-separator @@ -1644,9 +1678,9 @@ Method Descriptions |void| **_font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-item-separator @@ -1658,9 +1692,9 @@ Method Descriptions |void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. .. rst-class:: classref-item-separator @@ -1672,9 +1706,9 @@ Method Descriptions |void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero. .. rst-class:: classref-item-separator @@ -1686,9 +1720,9 @@ Method Descriptions |void| **_font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true`` auto-hinting is preferred over font built-in hinting. .. rst-class:: classref-item-separator @@ -1700,9 +1734,9 @@ Method Descriptions |void| **_font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true`` font texture mipmap generation is enabled. .. rst-class:: classref-item-separator @@ -1714,9 +1748,9 @@ Method Descriptions |void| **_font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets oversampling factor, shared by all font in the TextServer. .. rst-class:: classref-item-separator @@ -1728,9 +1762,9 @@ Method Descriptions |void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets glyph advance (offset of the next glyph). .. rst-class:: classref-item-separator @@ -1742,9 +1776,9 @@ Method Descriptions |void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets glyph offset from the baseline. .. rst-class:: classref-item-separator @@ -1756,9 +1790,9 @@ Method Descriptions |void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets size of the glyph. .. rst-class:: classref-item-separator @@ -1770,9 +1804,9 @@ Method Descriptions |void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets index of the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -1784,9 +1818,9 @@ Method Descriptions |void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-item-separator @@ -1798,9 +1832,9 @@ Method Descriptions |void| **_font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-item-separator @@ -1812,9 +1846,9 @@ Method Descriptions |void| **_font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets kerning for the pair of glyphs. .. rst-class:: classref-item-separator @@ -1826,9 +1860,9 @@ Method Descriptions |void| **_font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Adds override for :ref:`_font_is_language_supported`. .. rst-class:: classref-item-separator @@ -1840,9 +1874,9 @@ Method Descriptions |void| **_font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the width of the range around the shape between the minimum and maximum representable signed distance. .. rst-class:: classref-item-separator @@ -1854,9 +1888,9 @@ Method Descriptions |void| **_font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets source font size used to generate MSDF textures. .. rst-class:: classref-item-separator @@ -1868,9 +1902,9 @@ Method Descriptions |void| **_font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. .. rst-class:: classref-item-separator @@ -1882,9 +1916,9 @@ Method Descriptions |void| **_font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the font family name. .. rst-class:: classref-item-separator @@ -1896,9 +1930,9 @@ Method Descriptions |void| **_font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font OpenType feature set override. .. rst-class:: classref-item-separator @@ -1910,9 +1944,9 @@ Method Descriptions |void| **_font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. .. rst-class:: classref-item-separator @@ -1924,9 +1958,9 @@ Method Descriptions |void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets scaling factor of the color bitmap font. .. rst-class:: classref-item-separator @@ -1938,9 +1972,9 @@ Method Descriptions |void| **_font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Adds override for :ref:`_font_is_script_supported`. .. rst-class:: classref-item-separator @@ -1952,9 +1986,9 @@ Method Descriptions |void| **_font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). .. rst-class:: classref-item-separator @@ -1966,9 +2000,9 @@ Method Descriptions |void| **_font_set_stretch**\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. .. rst-class:: classref-item-separator @@ -1980,9 +2014,9 @@ Method Descriptions |void| **_font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the font style flags, see :ref:`FontStyle`. .. rst-class:: classref-item-separator @@ -1994,9 +2028,9 @@ Method Descriptions |void| **_font_set_style_name**\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the font style name. .. rst-class:: classref-item-separator @@ -2008,9 +2042,9 @@ Method Descriptions |void| **_font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font subpixel glyph positioning mode. .. rst-class:: classref-item-separator @@ -2022,9 +2056,9 @@ Method Descriptions |void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets font cache texture image data. .. rst-class:: classref-item-separator @@ -2036,9 +2070,9 @@ Method Descriptions |void| **_font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets array containing glyph packing data. .. rst-class:: classref-item-separator @@ -2050,9 +2084,9 @@ Method Descriptions |void| **_font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. .. rst-class:: classref-item-separator @@ -2064,9 +2098,9 @@ Method Descriptions |void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets pixel offset of the underline below the baseline. .. rst-class:: classref-item-separator @@ -2078,9 +2112,9 @@ Method Descriptions |void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets thickness of the underline in pixels. .. rst-class:: classref-item-separator @@ -2092,9 +2126,9 @@ Method Descriptions |void| **_font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets variation coordinates for the specified font cache entry. .. rst-class:: classref-item-separator @@ -2106,9 +2140,9 @@ Method Descriptions |void| **_font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. .. rst-class:: classref-item-separator @@ -2120,9 +2154,9 @@ Method Descriptions :ref:`Dictionary` **_font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the dictionary of the supported OpenType features. .. rst-class:: classref-item-separator @@ -2134,9 +2168,9 @@ Method Descriptions :ref:`Dictionary` **_font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the dictionary of the supported OpenType variation coordinates. .. rst-class:: classref-item-separator @@ -2146,11 +2180,11 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_format_number**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_format_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``. .. rst-class:: classref-item-separator @@ -2162,9 +2196,9 @@ Method Descriptions |void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Frees an object created by this :ref:`TextServer`. .. rst-class:: classref-item-separator @@ -2176,9 +2210,9 @@ Method Descriptions :ref:`int` **_get_features**\ (\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns text server features, see :ref:`Feature`. .. rst-class:: classref-item-separator @@ -2190,9 +2224,9 @@ Method Descriptions :ref:`Vector2` **_get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). .. rst-class:: classref-item-separator @@ -2204,9 +2238,9 @@ Method Descriptions :ref:`String` **_get_name**\ (\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the name of the server interface. .. rst-class:: classref-item-separator @@ -2218,9 +2252,9 @@ Method Descriptions :ref:`String` **_get_support_data_filename**\ (\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. .. rst-class:: classref-item-separator @@ -2232,9 +2266,9 @@ Method Descriptions :ref:`String` **_get_support_data_info**\ (\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns TextServer database (e.g. ICU break iterators and dictionaries) description. .. rst-class:: classref-item-separator @@ -2246,9 +2280,9 @@ Method Descriptions :ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if ``rid`` is valid resource owned by this text server. .. rst-class:: classref-item-separator @@ -2260,9 +2294,9 @@ Method Descriptions :ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if the server supports a feature. .. rst-class:: classref-item-separator @@ -2274,9 +2308,9 @@ Method Descriptions :ref:`int` **_is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found. .. rst-class:: classref-item-separator @@ -2288,9 +2322,9 @@ Method Descriptions :ref:`bool` **_is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if locale is right-to-left. .. rst-class:: classref-item-separator @@ -2302,9 +2336,9 @@ Method Descriptions :ref:`bool` **_is_valid_identifier**\ (\ string\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if ``string`` is a valid identifier. .. rst-class:: classref-item-separator @@ -2316,9 +2350,9 @@ Method Descriptions :ref:`bool` **_load_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Loads optional TextServer database (e.g. ICU break iterators and dictionaries). .. rst-class:: classref-item-separator @@ -2330,9 +2364,9 @@ Method Descriptions :ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Converts readable feature, variation, script, or language name to OpenType tag. .. rst-class:: classref-item-separator @@ -2342,11 +2376,11 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_parse_number**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| +:ref:`String` **_parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9). .. rst-class:: classref-item-separator @@ -2358,9 +2392,9 @@ Method Descriptions :ref:`Array`\[:ref:`Vector3i`\] **_parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser` for more info. .. rst-class:: classref-item-separator @@ -2372,9 +2406,9 @@ Method Descriptions :ref:`String` **_percent_sign**\ (\ language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns percent sign used in the ``language``. .. rst-class:: classref-item-separator @@ -2386,9 +2420,9 @@ Method Descriptions :ref:`bool` **_save_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. .. rst-class:: classref-item-separator @@ -2400,9 +2434,9 @@ Method Descriptions :ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns number of text spans added using :ref:`_shaped_text_add_string` or :ref:`_shaped_text_add_object`. .. rst-class:: classref-item-separator @@ -2414,9 +2448,9 @@ Method Descriptions :ref:`Variant` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns text span metadata. .. rst-class:: classref-item-separator @@ -2428,9 +2462,9 @@ Method Descriptions |void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Changes text span font, font size, and OpenType features, without changing the text. .. rst-class:: classref-item-separator @@ -2442,9 +2476,9 @@ Method Descriptions :ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. .. rst-class:: classref-item-separator @@ -2456,9 +2490,9 @@ Method Descriptions :ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Adds text span and font to draw it to the text buffer. .. rst-class:: classref-item-separator @@ -2470,9 +2504,9 @@ Method Descriptions |void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Clears text buffer (removes text and inline objects). .. rst-class:: classref-item-separator @@ -2484,9 +2518,9 @@ Method Descriptions :ref:`int` **_shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns composite character position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -2498,9 +2532,9 @@ Method Descriptions |void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). .. rst-class:: classref-item-separator @@ -2512,9 +2546,9 @@ Method Descriptions |void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draw the outline of the shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). .. rst-class:: classref-item-separator @@ -2526,9 +2560,9 @@ Method Descriptions :ref:`float` **_shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Adjusts text width to fit to specified width, returns new text width. .. rst-class:: classref-item-separator @@ -2540,9 +2574,9 @@ Method Descriptions :ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). .. rst-class:: classref-item-separator @@ -2554,9 +2588,9 @@ Method Descriptions |void| **_shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle. .. rst-class:: classref-item-separator @@ -2568,9 +2602,9 @@ Method Descriptions :ref:`PackedInt32Array` **_shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns array of the composite character boundaries. .. rst-class:: classref-item-separator @@ -2582,9 +2616,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ellipsis character used for text clipping. .. rst-class:: classref-item-separator @@ -2596,9 +2630,9 @@ Method Descriptions :ref:`String` **_shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. .. rst-class:: classref-item-separator @@ -2610,9 +2644,9 @@ Method Descriptions :ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). .. rst-class:: classref-item-separator @@ -2624,9 +2658,9 @@ Method Descriptions :ref:`Direction` **_shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns direction of the text. .. rst-class:: classref-item-separator @@ -2638,9 +2672,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns dominant direction of in the range of text. .. rst-class:: classref-item-separator @@ -2652,9 +2686,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns number of glyphs in the ellipsis. .. rst-class:: classref-item-separator @@ -2666,9 +2700,9 @@ Method Descriptions ``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns array of the glyphs in the ellipsis. .. rst-class:: classref-item-separator @@ -2680,9 +2714,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns position of the ellipsis. .. rst-class:: classref-item-separator @@ -2694,9 +2728,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns number of glyphs in the buffer. .. rst-class:: classref-item-separator @@ -2708,9 +2742,9 @@ Method Descriptions ``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of glyphs in the visual order. .. rst-class:: classref-item-separator @@ -2722,9 +2756,9 @@ Method Descriptions :ref:`Vector2` **_shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns composite character's bounds as offsets from the start of the line. .. rst-class:: classref-item-separator @@ -2736,9 +2770,9 @@ Method Descriptions :ref:`Direction` **_shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns direction of the text, inferred by the BiDi algorithm. .. rst-class:: classref-item-separator @@ -2750,9 +2784,9 @@ Method Descriptions :ref:`PackedInt32Array` **_shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Breaks text to the lines and returns character ranges for each line. .. rst-class:: classref-item-separator @@ -2764,9 +2798,37 @@ Method Descriptions :ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Breaks text to the lines and columns. Returns character ranges for each segment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_text_get_object_glyph: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| + +**Required.**\ + +Returns the glyph index of the inline object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_text_get_object_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **_shaped_text_get_object_range**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| + +**Required.**\ + +Returns the character range of the inline object. .. rst-class:: classref-item-separator @@ -2778,9 +2840,9 @@ Method Descriptions :ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns bounding rectangle of the inline object. .. rst-class:: classref-item-separator @@ -2792,9 +2854,9 @@ Method Descriptions :ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns array of inline objects. .. rst-class:: classref-item-separator @@ -2806,9 +2868,9 @@ Method Descriptions :ref:`Orientation` **_shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns text orientation. .. rst-class:: classref-item-separator @@ -2820,9 +2882,9 @@ Method Descriptions :ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the parent buffer from which the substring originates. .. rst-class:: classref-item-separator @@ -2834,9 +2896,9 @@ Method Descriptions :ref:`bool` **_shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if text buffer is configured to display control characters. .. rst-class:: classref-item-separator @@ -2848,9 +2910,9 @@ Method Descriptions :ref:`bool` **_shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters. .. rst-class:: classref-item-separator @@ -2862,9 +2924,9 @@ Method Descriptions :ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns substring buffer character range in the parent buffer. .. rst-class:: classref-item-separator @@ -2876,9 +2938,9 @@ Method Descriptions :ref:`PackedVector2Array` **_shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns selection rectangles for the specified character range. .. rst-class:: classref-item-separator @@ -2890,9 +2952,9 @@ Method Descriptions :ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns size of the text. .. rst-class:: classref-item-separator @@ -2904,9 +2966,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-item-separator @@ -2918,9 +2980,9 @@ Method Descriptions :ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the position of the overrun trim. .. rst-class:: classref-item-separator @@ -2932,9 +2994,9 @@ Method Descriptions :ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns pixel offset of the underline below the baseline. .. rst-class:: classref-item-separator @@ -2946,9 +3008,9 @@ Method Descriptions :ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns thickness of the underline. .. rst-class:: classref-item-separator @@ -2960,9 +3022,9 @@ Method Descriptions :ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-item-separator @@ -2974,9 +3036,9 @@ Method Descriptions :ref:`PackedInt32Array` **_shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking (see :ref:`GraphemeFlag`). .. rst-class:: classref-item-separator @@ -2988,9 +3050,9 @@ Method Descriptions :ref:`int` **_shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found. .. rst-class:: classref-item-separator @@ -3002,9 +3064,9 @@ Method Descriptions :ref:`int` **_shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. .. rst-class:: classref-item-separator @@ -3016,9 +3078,9 @@ Method Descriptions :ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if buffer is successfully shaped. .. rst-class:: classref-item-separator @@ -3030,9 +3092,9 @@ Method Descriptions :ref:`int` **_shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns composite character end position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3044,9 +3106,9 @@ Method Descriptions :ref:`int` **_shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns grapheme end position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3058,9 +3120,9 @@ Method Descriptions |void| **_shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Trims text if it exceeds the given width. .. rst-class:: classref-item-separator @@ -3072,9 +3134,9 @@ Method Descriptions :ref:`int` **_shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns composite character start position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3086,9 +3148,9 @@ Method Descriptions :ref:`int` **_shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns grapheme start position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3100,9 +3162,9 @@ Method Descriptions :ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets new size and alignment of embedded object. .. rst-class:: classref-item-separator @@ -3114,9 +3176,9 @@ Method Descriptions |void| **_shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Overrides BiDi for the structured text. .. rst-class:: classref-item-separator @@ -3128,9 +3190,9 @@ Method Descriptions |void| **_shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets ellipsis character used for text clipping. .. rst-class:: classref-item-separator @@ -3142,9 +3204,9 @@ Method Descriptions |void| **_shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. .. rst-class:: classref-item-separator @@ -3156,9 +3218,9 @@ Method Descriptions |void| **_shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets desired text direction. If set to :ref:`TextServer.DIRECTION_AUTO`, direction will be detected based on the buffer contents and current locale. .. rst-class:: classref-item-separator @@ -3170,9 +3232,9 @@ Method Descriptions |void| **_shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets desired text orientation. .. rst-class:: classref-item-separator @@ -3184,9 +3246,9 @@ Method Descriptions |void| **_shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true`` text buffer will display control characters. .. rst-class:: classref-item-separator @@ -3198,9 +3260,9 @@ Method Descriptions |void| **_shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. .. rst-class:: classref-item-separator @@ -3212,9 +3274,9 @@ Method Descriptions |void| **_shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-item-separator @@ -3226,9 +3288,9 @@ Method Descriptions :ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully. .. rst-class:: classref-item-separator @@ -3240,9 +3302,9 @@ Method Descriptions ``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns text glyphs in the logical order. .. rst-class:: classref-item-separator @@ -3254,9 +3316,9 @@ Method Descriptions :ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Required.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects). .. rst-class:: classref-item-separator @@ -3268,9 +3330,9 @@ Method Descriptions :ref:`float` **_shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Aligns shaped text to the given tab-stops. .. rst-class:: classref-item-separator @@ -3282,9 +3344,9 @@ Method Descriptions :ref:`bool` **_shaped_text_update_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Updates break points in the shaped text. This method is called by default implementation of text breaking functions. .. rst-class:: classref-item-separator @@ -3296,9 +3358,9 @@ Method Descriptions :ref:`bool` **_shaped_text_update_justification_ops**\ (\ shaped\: :ref:`RID`\ ) |virtual| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Updates justification points in the shaped text. This method is called by default implementation of text justification functions. .. rst-class:: classref-item-separator @@ -3310,9 +3372,9 @@ Method Descriptions :ref:`bool` **_spoof_check**\ (\ string\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader. .. rst-class:: classref-item-separator @@ -3324,9 +3386,9 @@ Method Descriptions :ref:`PackedInt32Array` **_string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns array of the composite character boundaries. .. rst-class:: classref-item-separator @@ -3338,9 +3400,9 @@ Method Descriptions :ref:`PackedInt32Array` **_string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even. .. rst-class:: classref-item-separator @@ -3352,9 +3414,9 @@ Method Descriptions :ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the string converted to lowercase. .. rst-class:: classref-item-separator @@ -3366,9 +3428,9 @@ Method Descriptions :ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the string converted to uppercase. .. rst-class:: classref-item-separator @@ -3380,9 +3442,9 @@ Method Descriptions :ref:`String` **_strip_diacritics**\ (\ string\: :ref:`String`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Strips diacritics from the string. .. rst-class:: classref-item-separator @@ -3394,9 +3456,9 @@ Method Descriptions :ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| -.. container:: contribute +**Optional.**\ - There is currently no description for this method. Please help us by :ref:`contributing one `! +Converts OpenType tag to readable feature, variation, script, or language name. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_time.rst b/classes/class_time.rst index 8455fd4d4..de5b71e42 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -25,7 +25,7 @@ This class conforms with as many of the ISO 8601 standards as possible. All date Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. -When getting time information from the system, the time can either be in the local timezone or UTC depending on the ``utc`` parameter. However, the :ref:`get_unix_time_from_system` method always returns the time in UTC. +When getting time information from the system, the time can either be in the local timezone or UTC depending on the ``utc`` parameter. However, the :ref:`get_unix_time_from_system` method always uses UTC as it returns the seconds passed since the `Unix epoch `__. \ **Important:** The ``_from_system`` methods use the system clock that the user can manually set. **Never use** this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. **Always use** :ref:`get_ticks_usec` or :ref:`get_ticks_msec` for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). @@ -559,7 +559,7 @@ Converts the given ISO 8601 date and/or time string to a Unix timestamp. The str :ref:`float` **get_unix_time_from_system**\ (\ ) |const| -Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. +Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. The Unix timestamp is the number of seconds passed since 1970-01-01 at 00:00:00, the `Unix epoch `__. \ **Note:** Unlike other methods that use integer timestamps, this method returns the timestamp as a :ref:`float` for sub-second precision. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index e10a7f07d..11395a689 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -1781,7 +1781,7 @@ In some cases, debanding may introduce a slightly noticeable dithering pattern. - |void| **set_use_hdr_2d**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_using_hdr_2d**\ (\ ) -If ``true``, 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be a ``RGBA16`` framebuffer, while when using the Mobile renderer it will be a ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. +If ``true``, 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. \ **Note:** This setting will have no effect when using the GL Compatibility renderer as the GL Compatibility renderer always renders in low dynamic range for performance reasons. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index c851c896a..81b9c95f5 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -23,7 +23,7 @@ Provides a low-level interface for creating parsers for `XML ` method or a buffer with the :ref:`open_buffer` method. Then, the :ref:`read` method must be called to parse the next nodes. Most of the methods take into consideration the currently parsed node. -Here is an example of using **XMLParser** to parse a SVG file (which is based on XML), printing each element and its attributes as a dictionary: +Here is an example of using **XMLParser** to parse an SVG file (which is based on XML), printing each element and its attributes as a dictionary: .. tabs:: diff --git a/classes/index.rst b/classes/index.rst index 10174ff3f..b57a6651c 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -335,11 +335,14 @@ Resources class_audioeffectstereoenhance class_audiostream class_audiostreamgenerator + class_audiostreaminteractive class_audiostreammicrophone class_audiostreammp3 class_audiostreamoggvorbis + class_audiostreamplaylist class_audiostreampolyphonic class_audiostreamrandomizer + class_audiostreamsynchronized class_audiostreamwav class_basematerial3d class_bitmap @@ -691,9 +694,12 @@ Other objects class_audioserver class_audiostreamgeneratorplayback class_audiostreamplayback + class_audiostreamplaybackinteractive class_audiostreamplaybackoggvorbis + class_audiostreamplaybackplaylist class_audiostreamplaybackpolyphonic class_audiostreamplaybackresampled + class_audiostreamplaybacksynchronized class_callbacktweener class_camerafeed class_cameraserver