From a7e99ea01793debd41d231256441f185a9cc3560 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 4 May 2024 03:20:12 +0000 Subject: [PATCH] classref: Sync with current master branch (03e6fbb) --- classes/class_@globalscope.rst | 16 +- classes/class_animation.rst | 34 +- classes/class_animationplayer.rst | 208 +- classes/class_array.rst | 12 + classes/class_audioeffectspectrumanalyzer.rst | 2 - classes/class_audiostreamwav.rst | 10 +- classes/class_basematerial3d.rst | 8 + classes/class_canvasitem.rst | 12 +- classes/class_codeedit.rst | 78 +- classes/class_diraccess.rst | 50 + classes/class_displayserver.rst | 54 +- classes/class_editorexportplatformios.rst | 2268 ++++++++++++++++- classes/class_editorsettings.rst | 52 +- classes/class_hingejoint3d.rst | 8 +- classes/class_input.rst | 8 +- classes/class_mobilevrinterface.rst | 19 + classes/class_node2d.rst | 4 +- classes/class_openxrapiextension.rst | 16 +- classes/class_openxrinterface.rst | 40 + classes/class_packedscene.rst | 4 +- classes/class_packedvector4array.rst | 492 ++++ classes/class_projectsettings.rst | 16 +- classes/class_rect2.rst | 4 +- classes/class_rect2i.rst | 4 +- classes/class_renderingserver.rst | 14 + classes/class_resourceimporterwav.rst | 2 + classes/class_richtextlabel.rst | 20 +- classes/class_statusindicator.rst | 70 +- classes/class_string.rst | 2 +- classes/class_stringname.rst | 2 +- classes/class_textedit.rst | 871 ++++--- classes/class_textserver.rst | 14 + classes/class_textserverextension.rst | 16 + classes/class_tilesetatlassource.rst | 11 + classes/class_variant.rst | 4 +- classes/class_vector2.rst | 84 + classes/class_vector2i.rst | 84 + classes/class_vector3.rst | 92 +- classes/class_vector3i.rst | 84 + classes/class_vector4.rst | 84 + classes/class_vector4i.rst | 84 + classes/class_xrserver.rst | 4 +- classes/index.rst | 1 + 43 files changed, 4431 insertions(+), 531 deletions(-) create mode 100644 classes/class_packedvector4array.rst diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 8fa65f006..4209e8410 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -4514,11 +4514,19 @@ Variable is of type :ref:`PackedVector3Array`. Variable is of type :ref:`PackedColorArray`. +.. _class_@GlobalScope_constant_TYPE_PACKED_VECTOR4_ARRAY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Variant.Type` **TYPE_PACKED_VECTOR4_ARRAY** = ``38`` + +Variable is of type :ref:`PackedVector4Array`. + .. _class_@GlobalScope_constant_TYPE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Variant.Type` **TYPE_MAX** = ``38`` +:ref:`Variant.Type` **TYPE_MAX** = ``39`` Represents the size of the :ref:`Variant.Type` enum. @@ -6064,7 +6072,7 @@ Returns ``true``, for value types, if ``a`` and ``b`` share the same value. Retu These are :ref:`Variant` value types: ``null``, :ref:`bool`, :ref:`int`, :ref:`float`, :ref:`String`, :ref:`StringName`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`, :ref:`Rect2`, :ref:`Rect2i`, :ref:`Transform2D`, :ref:`Transform3D`, :ref:`Plane`, :ref:`Quaternion`, :ref:`AABB`, :ref:`Basis`, :ref:`Projection`, :ref:`Color`, :ref:`NodePath`, :ref:`RID`, :ref:`Callable` and :ref:`Signal`. -These are :ref:`Variant` reference types: :ref:`Object`, :ref:`Dictionary`, :ref:`Array`, :ref:`PackedByteArray`, :ref:`PackedInt32Array`, :ref:`PackedInt64Array`, :ref:`PackedFloat32Array`, :ref:`PackedFloat64Array`, :ref:`PackedStringArray`, :ref:`PackedVector2Array`, :ref:`PackedVector3Array` and :ref:`PackedColorArray`. +These are :ref:`Variant` reference types: :ref:`Object`, :ref:`Dictionary`, :ref:`Array`, :ref:`PackedByteArray`, :ref:`PackedInt32Array`, :ref:`PackedInt64Array`, :ref:`PackedFloat32Array`, :ref:`PackedFloat64Array`, :ref:`PackedStringArray`, :ref:`PackedVector2Array`, :ref:`PackedVector3Array`, :ref:`PackedVector4Array`, and :ref:`PackedColorArray`. .. rst-class:: classref-item-separator @@ -6203,6 +6211,8 @@ Returns the maximum of the given numeric values. This function can take any numb max(1, 7, 3, -6, 5) # Returns 7 +\ **Note:** When using this on vectors it will *not* perform component-wise maximum, and will pick the largest value when compared using ``x < y``. To perform component-wise maximum, use :ref:`Vector2.max`, :ref:`Vector2i.max`, :ref:`Vector3.max`, :ref:`Vector3i.max`, :ref:`Vector4.max`, and :ref:`Vector4i.max`. + .. rst-class:: classref-item-separator ---- @@ -6253,6 +6263,8 @@ Returns the minimum of the given numeric values. This function can take any numb min(1, 7, 3, -6, 5) # Returns -6 +\ **Note:** When using this on vectors it will *not* perform component-wise minimum, and will pick the smallest value when compared using ``x < y``. To perform component-wise minimum, use :ref:`Vector2.min`, :ref:`Vector2i.min`, :ref:`Vector3.min`, :ref:`Vector3i.min`, :ref:`Vector4.min`, and :ref:`Vector4i.min`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_animation.rst b/classes/class_animation.rst index f1ad91a57..2a9cdeebc 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -67,13 +67,15 @@ Properties .. table:: :widths: auto - +------------------------------------------+------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`length` | ``1.0`` | - +------------------------------------------+------------------------------------------------------+---------------+ - | :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | - +------------------------------------------+------------------------------------------------------+---------------+ - | :ref:`float` | :ref:`step` | ``0.0333333`` | - +------------------------------------------+------------------------------------------------------+---------------+ + +------------------------------------------+--------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`capture_included` | ``false`` | + +------------------------------------------+--------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`length` | ``1.0`` | + +------------------------------------------+--------------------------------------------------------------------+---------------+ + | :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | + +------------------------------------------+--------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`step` | ``0.0333333`` | + +------------------------------------------+--------------------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group @@ -392,7 +394,7 @@ Update at the keyframes. :ref:`UpdateMode` **UPDATE_CAPTURE** = ``2`` -Same as :ref:`UPDATE_CONTINUOUS` but works as a flag to capture the value of the current object and perform interpolation in some methods. See also :ref:`AnimationMixer.capture` and :ref:`AnimationPlayer.play_with_capture`. +Same as :ref:`UPDATE_CONTINUOUS` but works as a flag to capture the value of the current object and perform interpolation in some methods. See also :ref:`AnimationMixer.capture`, :ref:`AnimationPlayer.playback_auto_capture`, and :ref:`AnimationPlayer.play_with_capture`. .. rst-class:: classref-item-separator @@ -505,6 +507,22 @@ Finds only the key with matching the time. Property Descriptions --------------------- +.. _class_Animation_property_capture_included: + +.. rst-class:: classref-property + +:ref:`bool` **capture_included** = ``false`` + +.. rst-class:: classref-property-setget + +- :ref:`bool` **is_capture_included**\ (\ ) + +Returns ``true`` if the capture track is included. This is a cached readonly value for performance. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_property_length: .. rst-class:: classref-property diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 51ae0cfc7..fc8a9fd69 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -46,23 +46,31 @@ Properties .. table:: :widths: auto - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`assigned_animation` | | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`autoplay` | ``""`` | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`current_animation` | ``""`` | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`current_animation_length` | | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`current_animation_position` | | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`movie_quit_on_finish` | ``false`` | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`playback_default_blend_time` | ``0.0`` | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`speed_scale` | ``1.0`` | - +-----------------------------+------------------------------------------------------------------------------------------------+-----------+ + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`assigned_animation` | | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`autoplay` | ``""`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`current_animation` | ``""`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`current_animation_length` | | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`current_animation_position` | | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`movie_quit_on_finish` | ``false`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`playback_auto_capture` | ``true`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`playback_auto_capture_duration` | ``-1.0`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`EaseType` | :ref:`playback_auto_capture_ease_type` | ``0`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`TransitionType` | :ref:`playback_auto_capture_transition_type` | ``0`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`playback_default_blend_time` | ``0.0`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`speed_scale` | ``1.0`` | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -72,49 +80,49 @@ Methods .. table:: :widths: auto - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`animation_get_next`\ (\ animation_from\: :ref:`StringName`\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`animation_set_next`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_queue`\ (\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationMethodCallMode` | :ref:`get_method_call_mode`\ (\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playing_speed`\ (\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationProcessCallback` | :ref:`get_process_callback`\ (\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_queue`\ (\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_root`\ (\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`pause`\ (\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`play`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`play_with_capture`\ (\ name\: :ref:`StringName`, duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`queue`\ (\ name\: :ref:`StringName`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`seek`\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_method_call_mode`\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_process_callback`\ (\ mode\: :ref:`AnimationProcessCallback`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_root`\ (\ path\: :ref:`NodePath`\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`stop`\ (\ keep_state\: :ref:`bool` = false\ ) | - +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`animation_get_next`\ (\ animation_from\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`animation_set_next`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_queue`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationMethodCallMode` | :ref:`get_method_call_mode`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playing_speed`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationProcessCallback` | :ref:`get_process_callback`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_queue`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_root`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pause`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_with_capture`\ (\ name\: :ref:`StringName` = &"", duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_method_call_mode`\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_callback`\ (\ mode\: :ref:`AnimationProcessCallback`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root`\ (\ path\: :ref:`NodePath`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ keep_state\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -335,6 +343,78 @@ If ``true`` and the engine is running in Movie Maker mode (see :ref:`MovieWriter ---- +.. _class_AnimationPlayer_property_playback_auto_capture: + +.. rst-class:: classref-property + +:ref:`bool` **playback_auto_capture** = ``true`` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_capture**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_capture**\ (\ ) + +If ``true``, performs :ref:`AnimationMixer.capture` before playback automatically. This means just :ref:`play_with_capture` is executed with default arguments instead of :ref:`play`. + +\ **Note:** Capture interpolation is only performed if the animation contains a capture track. See also :ref:`Animation.UPDATE_CAPTURE`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_property_playback_auto_capture_duration: + +.. rst-class:: classref-property + +:ref:`float` **playback_auto_capture_duration** = ``-1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_capture_duration**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_capture_duration**\ (\ ) + +See also :ref:`play_with_capture` and :ref:`AnimationMixer.capture`. + +If :ref:`playback_auto_capture_duration` is negative value, the duration is set to the interval between the current position and the first key. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_property_playback_auto_capture_ease_type: + +.. rst-class:: classref-property + +:ref:`EaseType` **playback_auto_capture_ease_type** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_capture_ease_type**\ (\ value\: :ref:`EaseType`\ ) +- :ref:`EaseType` **get_auto_capture_ease_type**\ (\ ) + +The ease type of the capture interpolation. See also :ref:`EaseType`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationPlayer_property_playback_auto_capture_transition_type: + +.. rst-class:: classref-property + +:ref:`TransitionType` **playback_auto_capture_transition_type** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_capture_transition_type**\ (\ value\: :ref:`TransitionType`\ ) +- :ref:`TransitionType` **get_auto_capture_transition_type**\ (\ ) + +The transition type of the capture interpolation. See also :ref:`TransitionType`. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationPlayer_property_playback_default_blend_time: .. rst-class:: classref-property @@ -554,16 +634,18 @@ This method is a shorthand for :ref:`play` wi .. rst-class:: classref-method -|void| **play_with_capture**\ (\ name\: :ref:`StringName`, duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) +|void| **play_with_capture**\ (\ name\: :ref:`StringName` = &"", duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) -See :ref:`AnimationMixer.capture`. It is almost the same as the following: +See also :ref:`AnimationMixer.capture`. + +You can use this method to use more detailed options for capture than those performed by :ref:`playback_auto_capture`. When :ref:`playback_auto_capture` is ``false``, this method is almost the same as the following: :: capture(name, duration, trans_type, ease_type) play(name, custom_blend, custom_speed, from_end) -If name is blank, it specifies :ref:`assigned_animation`. +If ``name`` is blank, it specifies :ref:`assigned_animation`. If ``duration`` is a negative value, the duration is set to the interval between the current position and the first key, when ``from_end`` is ``true``, uses the interval between the current position and the last key instead. diff --git a/classes/class_array.rst b/classes/class_array.rst index 47a156670..16b40b07b 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -107,6 +107,8 @@ Constructors +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedVector3Array`\ ) | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedVector4Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -393,6 +395,16 @@ Constructs an array from a :ref:`PackedVector2Array`. Constructs an array from a :ref:`PackedVector3Array`. +.. rst-class:: classref-item-separator + +---- + +.. rst-class:: classref-constructor + +:ref:`Array` **Array**\ (\ from\: :ref:`PackedVector4Array`\ ) + +Constructs an array from a :ref:`PackedVector4Array`. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 35df039c0..685bcdc5e 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -30,8 +30,6 @@ Tutorials - `Audio Spectrum Visualizer Demo `__ -- `Godot 3.2 will get new audio features `__ - .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index a17aaa9cc..4c741303e 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -105,6 +105,14 @@ enum **Format**: Audio is compressed using IMA ADPCM. +.. _class_AudioStreamWAV_constant_FORMAT_QOA: + +.. rst-class:: classref-enumeration-constant + +:ref:`Format` **FORMAT_QOA** = ``3`` + +Audio is compressed as QOA (`Quite OK Audio `__). + .. rst-class:: classref-item-separator ---- @@ -294,7 +302,7 @@ Method Descriptions :ref:`Error` **save_to_wav**\ (\ path\: :ref:`String`\ ) -Saves the AudioStreamWAV as a WAV file to ``path``. Samples with IMA ADPCM format can't be saved. +Saves the AudioStreamWAV as a WAV file to ``path``. Samples with IMA ADPCM or QOA formats can't be saved. \ **Note:** A ``.wav`` extension is automatically appended to ``path`` if it is missing. diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 0d7b202d5..14213c9d0 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -811,6 +811,14 @@ The color of the object is subtracted from the background. The color of the object is multiplied by the background. +.. _class_BaseMaterial3D_constant_BLEND_MODE_PREMULT_ALPHA: + +.. rst-class:: classref-enumeration-constant + +:ref:`BlendMode` **BLEND_MODE_PREMULT_ALPHA** = ``4`` + +The color of the object is added to the background and the alpha channel is used to mask out the background. This is effectively a hybrid of the blend mix and add modes, useful for effects like fire where you want the flame to add but the smoke to mix. By default, this works with unshaded materials using premultiplied textures. For shaded materials, use the ``PREMUL_ALPHA_FACTOR`` built-in so that lighting can be modulated as well. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 885739232..a8f2d8d3f 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -101,7 +101,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`draw_char_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_circle`\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) | + | |void| | :ref:`draw_circle`\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`draw_colored_polygon`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -856,9 +856,15 @@ Draws a string first character outline using a custom font. .. rst-class:: classref-method -|void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) +|void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) -Draws a colored, filled circle. See also :ref:`draw_arc`, :ref:`draw_polyline` and :ref:`draw_polygon`. +Draws a circle. See also :ref:`draw_arc`, :ref:`draw_polyline`, and :ref:`draw_polygon`. + +If ``filled`` is ``true``, the circle will be filled with the ``color`` specified. If ``filled`` is ``false``, the circle will be drawn as a stroke with the ``color`` and ``width`` specified. + +If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. + +\ **Note:** ``width`` is only effective if ``filled`` is ``false``. .. rst-class:: classref-item-separator diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index d2c2a9bda..b430f84ef 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -120,10 +120,14 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_code_region`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`do_indent`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`duplicate_lines`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`duplicate_selection`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fold_all_lines`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fold_line`\ (\ line\: :ref:`int`\ ) | @@ -188,6 +192,10 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_line_folded`\ (\ line\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_lines_down`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_lines_up`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_comment_delimiter`\ (\ start_key\: :ref:`String`\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_string_delimiter`\ (\ start_key\: :ref:`String`\ ) | @@ -212,6 +220,8 @@ Methods +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`toggle_foldable_line`\ (\ line\: :ref:`int`\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_foldable_lines_at_carets`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unfold_all_lines`\ (\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unfold_line`\ (\ line\: :ref:`int`\ ) | @@ -831,7 +841,7 @@ Method Descriptions |void| **_confirm_code_completion**\ (\ replace\: :ref:`bool`\ ) |virtual| -Override this method to define how the selected entry should be inserted. If ``replace`` is true, any existing text should be replaced. +Override this method to define how the selected entry should be inserted. If ``replace`` is ``true``, any existing text should be replaced. .. rst-class:: classref-item-separator @@ -857,7 +867,7 @@ Both ``candidates`` and the return is a :ref:`Array` of :ref:`Dicti |void| **_request_code_completion**\ (\ force\: :ref:`bool`\ ) |virtual| -Override this method to define what happens when the user requests code completion. If ``force`` is true, any checks should be bypassed. +Override this method to define what happens when the user requests code completion. If ``force`` is ``true``, any checks should be bypassed. .. rst-class:: classref-item-separator @@ -1011,7 +1021,7 @@ Removes all string delimiters. |void| **confirm_code_completion**\ (\ replace\: :ref:`bool` = false\ ) -Inserts the selected entry into the text. If ``replace`` is true, any existing text is replaced rather than merged. +Inserts the selected entry into the text. If ``replace`` is ``true``, any existing text is replaced rather than merged. .. rst-class:: classref-item-separator @@ -1049,6 +1059,18 @@ Code regions are delimited using start and end tags (respectively ``region`` and ---- +.. _class_CodeEdit_method_delete_lines: + +.. rst-class:: classref-method + +|void| **delete_lines**\ (\ ) + +Deletes all lines that are selected or have a caret on them. + +.. rst-class:: classref-item-separator + +---- + .. _class_CodeEdit_method_do_indent: .. rst-class:: classref-method @@ -1073,6 +1095,18 @@ Duplicates all lines currently selected with any caret. Duplicates the entire li ---- +.. _class_CodeEdit_method_duplicate_selection: + +.. rst-class:: classref-method + +|void| **duplicate_selection**\ (\ ) + +Duplicates all selected text and duplicates all lines with a caret on them. + +.. rst-class:: classref-item-separator + +---- + .. _class_CodeEdit_method_fold_all_lines: .. rst-class:: classref-method @@ -1469,6 +1503,30 @@ Returns whether the line at the specified index is folded or not. ---- +.. _class_CodeEdit_method_move_lines_down: + +.. rst-class:: classref-method + +|void| **move_lines_down**\ (\ ) + +Moves all lines down that are selected or have a caret on them. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CodeEdit_method_move_lines_up: + +.. rst-class:: classref-method + +|void| **move_lines_up**\ (\ ) + +Moves all lines up that are selected or have a caret on them. + +.. rst-class:: classref-item-separator + +---- + .. _class_CodeEdit_method_remove_comment_delimiter: .. rst-class:: classref-method @@ -1499,7 +1557,7 @@ Removes the string delimiter with ``start_key``. |void| **request_code_completion**\ (\ force\: :ref:`bool` = false\ ) -Emits :ref:`code_completion_requested`, if ``force`` is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. +Emits :ref:`code_completion_requested`, if ``force`` is ``true`` will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path, or signal. .. rst-class:: classref-item-separator @@ -1613,6 +1671,18 @@ Toggle the folding of the code block at the given line. ---- +.. _class_CodeEdit_method_toggle_foldable_lines_at_carets: + +.. rst-class:: classref-method + +|void| **toggle_foldable_lines_at_carets**\ (\ ) + +Toggle the folding of the code block on all lines with a caret on them. + +.. rst-class:: classref-item-separator + +---- + .. _class_CodeEdit_method_unfold_all_lines: .. rst-class:: classref-method diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 3d6761613..57735366c 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -125,6 +125,8 @@ Methods +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`copy_absolute`\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) |static| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_link`\ (\ source\: :ref:`String`, target\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`current_is_dir`\ (\ ) |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`dir_exists`\ (\ path\: :ref:`String`\ ) | @@ -157,6 +159,8 @@ Methods +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_case_sensitive`\ (\ path\: :ref:`String`\ ) |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_link`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`list_dir_begin`\ (\ ) | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`list_dir_end`\ (\ ) | @@ -171,6 +175,8 @@ Methods +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`DirAccess` | :ref:`open`\ (\ path\: :ref:`String`\ ) |static| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`read_link`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`remove`\ (\ path\: :ref:`String`\ ) | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`remove_absolute`\ (\ path\: :ref:`String`\ ) |static| | @@ -276,6 +282,22 @@ Static version of :ref:`copy`. Supports only absolu ---- +.. _class_DirAccess_method_create_link: + +.. rst-class:: classref-method + +:ref:`Error` **create_link**\ (\ source\: :ref:`String`, target\: :ref:`String`\ ) + +Creates symbolic link between files or folders. + +\ **Note:** On Windows, this method works only if the application is running with elevated privileges or Developer Mode is enabled. + +\ **Note:** This method is implemented on macOS, Linux, and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_current_is_dir: .. rst-class:: classref-method @@ -496,6 +518,20 @@ Returns ``true`` if the file system or directory use case sensitive file names. ---- +.. _class_DirAccess_method_is_link: + +.. rst-class:: classref-method + +:ref:`bool` **is_link**\ (\ path\: :ref:`String`\ ) + +Returns ``true`` if the file or directory is a symbolic link, directory junction, or other reparse point. + +\ **Note:** This method is implemented on macOS, Linux, and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_list_dir_begin: .. rst-class:: classref-method @@ -590,6 +626,20 @@ Returns ``null`` if opening the directory failed. You can use :ref:`get_open_err ---- +.. _class_DirAccess_method_read_link: + +.. rst-class:: classref-method + +:ref:`String` **read_link**\ (\ path\: :ref:`String`\ ) + +Returns target of the symbolic link. + +\ **Note:** This method is implemented on macOS, Linux, and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_remove: .. rst-class:: classref-method diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index f99ce58eb..54cd388d4 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -46,7 +46,7 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Image`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | + | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -260,9 +260,13 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Image`\ ) | + | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_menu`\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1574,7 +1578,7 @@ Sets the user's `primary ` **create_status_indicator**\ (\ icon\: :ref:`Image`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) +:ref:`int` **create_status_indicator**\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) Creates a new application status indicator with the specified icon, tooltip, and activation callback. @@ -3379,6 +3383,20 @@ Sets the ``callable`` that should be called when system theme settings are chang ---- +.. _class_DisplayServer_method_status_indicator_get_rect: + +.. rst-class:: classref-method + +:ref:`Rect2` **status_indicator_get_rect**\ (\ id\: :ref:`int`\ ) |const| + +Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2`. + +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_status_indicator_set_callback: .. rst-class:: classref-method @@ -3387,6 +3405,8 @@ Sets the ``callable`` that should be called when system theme settings are chang Sets the application status indicator activation callback. +\ **Note:** This method is implemented on macOS and Windows. + .. rst-class:: classref-item-separator ---- @@ -3395,10 +3415,30 @@ Sets the application status indicator activation callback. .. rst-class:: classref-method -|void| **status_indicator_set_icon**\ (\ id\: :ref:`int`, icon\: :ref:`Image`\ ) +|void| **status_indicator_set_icon**\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets the application status indicator icon. +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_status_indicator_set_menu: + +.. rst-class:: classref-method + +|void| **status_indicator_set_menu**\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) + +Sets the application status indicator native popup menu. + +\ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered. + +\ **Note:** On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing :kbd:`Shift + F10`, or the applications key. The menu's activation callback for the other mouse buttons is still triggered. + +\ **Note:** Native popup is only supported if :ref:`NativeMenu` supports the :ref:`NativeMenu.FEATURE_POPUP_MENU` feature. + .. rst-class:: classref-item-separator ---- @@ -3411,6 +3451,8 @@ Sets the application status indicator icon. Sets the application status indicator tooltip. +\ **Note:** This method is implemented on macOS and Windows. + .. rst-class:: classref-item-separator ---- @@ -4115,7 +4157,7 @@ Sets the ``callback`` that should be called when text is entered using the virtu |void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) -Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_max_size`. +Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_max_size`. \ **Note:** It's recommended to change this value using :ref:`Window.max_size` instead. @@ -4131,7 +4173,7 @@ Sets the maximum size of the window specified by ``window_id`` in pixels. Normal |void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) -Sets the minimum size for the given window to ``min_size`` (in pixels). Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_min_size`. +Sets the minimum size for the given window to ``min_size`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_min_size`. \ **Note:** It's recommended to change this value using :ref:`Window.min_size` instead. diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 6d86e3787..98080c05b 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -31,103 +31,399 @@ Properties .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/additional_plist_content` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/app_store_team_id` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/bundle_identifier` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/code_sign_identity_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/code_sign_identity_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/export_method_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/export_method_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/export_project_only` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/icon_interpolation` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/min_ios_version` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/short_version` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/signature` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/targeted_device_family` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/version` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`architectures/arm64` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/access_wifi` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/performance_a12` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/performance_gaming_tier` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/push_notifications` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`custom_template/debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`custom_template/release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/app_store_1024x1024` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_76x76` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_152x152` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_167x167` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/iphone_120x120` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/iphone_180x180` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/notification_40x40` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/notification_60x60` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/settings_58x58` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/settings_87x87` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/spotlight_40x40` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/spotlight_80x80` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/camera_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/microphone_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`storyboard/custom_bg_color` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`storyboard/custom_image@2x` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`storyboard/custom_image@3x` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`storyboard/image_scale_mode` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`storyboard/use_custom_bg_color` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/additional_plist_content` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/app_store_team_id` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/bundle_identifier` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/delete_old_export_files_unconditionally` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/export_project_only` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/min_ios_version` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/short_version` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/signature` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/targeted_device_family` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/version` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/arm64` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/access_wifi` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/performance_a12` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/performance_gaming_tier` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/push_notifications` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/app_store_1024x1024` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_76x76` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_152x152` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_167x167` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_120x120` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_180x180` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_40x40` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_60x60` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_58x58` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_87x87` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_40x40` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_80x80` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/active_keyboard_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/camera_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/advertising_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/audio_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/browsing_history/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/coarse_location/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/contacts/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/crash_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/credit_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/customer_support/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/device_id/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/email_address/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/emails_or_text_messages/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/environment_scanning/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/fitness/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/gameplay_content/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/hands/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/head/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/health/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/name/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_contact_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_data_types/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_diagnostic_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_financial_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_usage_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_user_content/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/payment_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/performance_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/phone_number/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/photos_or_videos/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/physical_address/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/precise_location/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/product_interaction/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/purchase_history/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/sensitive_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/user_id/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/disk_space_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/file_timestamp_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/microphone_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/system_boot_time_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`privacy/tracking_domains` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/tracking_enabled` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/user_defaults_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`storyboard/custom_bg_color` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@2x` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@3x` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`storyboard/image_scale_mode` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`storyboard/use_custom_bg_color` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -203,6 +499,18 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for re ---- +.. _class_EditorExportPlatformIOS_property_application/delete_old_export_files_unconditionally: + +.. rst-class:: classref-property + +:ref:`bool` **application/delete_old_export_files_unconditionally** + +If ``true``, existing "project name" and "project name.xcodeproj" in the export destination directory will be unconditionally deleted during export. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_application/export_method_debug: .. rst-class:: classref-property @@ -571,6 +879,18 @@ Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback ---- +.. _class_EditorExportPlatformIOS_property_privacy/active_keyboard_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/active_keyboard_access_reasons** + +The reasons your app use active keyboard API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description: .. rst-class:: classref-property @@ -595,6 +915,1710 @@ A message displayed when requesting access to the device's camera (localized). ---- +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/collected** + +Indicates whether your app collects advertising data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** + +The reasons your app collects advertising data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** + +Indicates whether your app links advertising data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** + +Indicates whether your app uses advertising data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/collected** + +Indicates whether your app collects audio data data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/audio_data/collection_purposes** + +The reasons your app collects audio data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** + +Indicates whether your app links audio data data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** + +Indicates whether your app uses audio data data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/collected** + +Indicates whether your app collects browsing history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** + +The reasons your app collects browsing history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** + +Indicates whether your app links browsing history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** + +Indicates whether your app uses browsing history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/collected** + +Indicates whether your app collects coarse location data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** + +The reasons your app collects coarse location data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** + +Indicates whether your app links coarse location data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** + +Indicates whether your app uses coarse location data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/collected** + +Indicates whether your app collects contacts. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/contacts/collection_purposes** + +The reasons your app collects contacts. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/linked_to_user** + +Indicates whether your app links contacts to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** + +Indicates whether your app uses contacts for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/collected** + +Indicates whether your app collects crash data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/crash_data/collection_purposes** + +The reasons your app collects crash data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** + +Indicates whether your app links crash data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** + +Indicates whether your app uses crash data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/collected** + +Indicates whether your app collects credit information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/credit_info/collection_purposes** + +The reasons your app collects credit information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** + +Indicates whether your app links credit information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** + +Indicates whether your app uses credit information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/collected** + +Indicates whether your app collects customer support data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/customer_support/collection_purposes** + +The reasons your app collects customer support data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** + +Indicates whether your app links customer support data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** + +Indicates whether your app uses customer support data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/collected** + +Indicates whether your app collects device IDs. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/device_id/collection_purposes** + +The reasons your app collects device IDs. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/linked_to_user** + +Indicates whether your app links device IDs to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** + +Indicates whether your app uses device IDs for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/collected** + +Indicates whether your app collects email address. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/email_address/collection_purposes** + +The reasons your app collects email address. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/linked_to_user** + +Indicates whether your app links email address to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** + +Indicates whether your app uses email address for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** + +Indicates whether your app collects emails or text messages. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** + +The reasons your app collects emails or text messages. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** + +Indicates whether your app links emails or text messages to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** + +Indicates whether your app uses emails or text messages for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/collected** + +Indicates whether your app collects environment scanning data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** + +The reasons your app collects environment scanning data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** + +Indicates whether your app links environment scanning data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** + +Indicates whether your app uses environment scanning data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/collected** + +Indicates whether your app collects fitness and exercise data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/fitness/collection_purposes** + +The reasons your app collects fitness and exercise data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/linked_to_user** + +Indicates whether your app links fitness and exercise data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** + +Indicates whether your app uses fitness and exercise data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/collected** + +Indicates whether your app collects gameplay content. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** + +The reasons your app collects gameplay content. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** + +Indicates whether your app links gameplay content to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** + +Indicates whether your app uses gameplay content for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/collected** + +Indicates whether your app collects user's hand structure and hand movements. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/hands/collection_purposes** + +The reasons your app collects user's hand structure and hand movements. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/linked_to_user** + +Indicates whether your app links user's hand structure and hand movements to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/used_for_tracking** + +Indicates whether your app uses user's hand structure and hand movements for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/collected** + +Indicates whether your app collects user's head movement. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/head/collection_purposes** + +The reasons your app collects user's head movement. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/linked_to_user** + +Indicates whether your app links user's head movement to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/used_for_tracking** + +Indicates whether your app uses user's head movement for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/collected** + +Indicates whether your app collects health and medical data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/health/collection_purposes** + +The reasons your app collects health and medical data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/linked_to_user** + +Indicates whether your app links health and medical data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/used_for_tracking** + +Indicates whether your app uses health and medical data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/collected** + +Indicates whether your app collects user's name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/name/collection_purposes** + +The reasons your app collects user's name. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/linked_to_user** + +Indicates whether your app links user's name to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/used_for_tracking** + +Indicates whether your app uses user's name for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/collected** + +Indicates whether your app collects any other contact information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** + +The reasons your app collects any other contact information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** + +Indicates whether your app links any other contact information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** + +Indicates whether your app uses any other contact information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/collected** + +Indicates whether your app collects any other data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** + +The reasons your app collects any other data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** + +Indicates whether your app links any other data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** + +Indicates whether your app uses any other data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** + +Indicates whether your app collects any other diagnostic data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** + +The reasons your app collects any other diagnostic data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** + +Indicates whether your app links any other diagnostic data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** + +Indicates whether your app uses any other diagnostic data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/collected** + +Indicates whether your app collects any other financial information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** + +The reasons your app collects any other financial information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** + +Indicates whether your app links any other financial information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** + +Indicates whether your app uses any other financial information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/collected** + +Indicates whether your app collects any other usage data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** + +The reasons your app collects any other usage data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** + +Indicates whether your app links any other usage data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** + +Indicates whether your app uses any other usage data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/collected** + +Indicates whether your app collects any other user generated content. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** + +The reasons your app collects any other user generated content. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** + +Indicates whether your app links any other user generated content to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** + +Indicates whether your app uses any other user generated content for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/collected** + +Indicates whether your app collects payment information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/payment_info/collection_purposes** + +The reasons your app collects payment information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** + +Indicates whether your app links payment information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** + +Indicates whether your app uses payment information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/collected** + +Indicates whether your app collects performance data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/performance_data/collection_purposes** + +The reasons your app collects performance data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** + +Indicates whether your app links performance data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** + +Indicates whether your app uses performance data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/collected** + +Indicates whether your app collects phone number. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/phone_number/collection_purposes** + +The reasons your app collects phone number. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** + +Indicates whether your app links phone number to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** + +Indicates whether your app uses phone number for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/collected** + +Indicates whether your app collects photos or videos. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** + +The reasons your app collects photos or videos. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** + +Indicates whether your app links photos or videos to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** + +Indicates whether your app uses photos or videos for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/collected** + +Indicates whether your app collects physical address. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/physical_address/collection_purposes** + +The reasons your app collects physical address. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** + +Indicates whether your app links physical address to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** + +Indicates whether your app uses physical address for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/collected** + +Indicates whether your app collects precise location data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/precise_location/collection_purposes** + +The reasons your app collects precise location data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** + +Indicates whether your app links precise location data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** + +Indicates whether your app uses precise location data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/collected** + +Indicates whether your app collects product interaction data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** + +The reasons your app collects product interaction data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** + +Indicates whether your app links product interaction data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** + +Indicates whether your app uses product interaction data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/collected** + +Indicates whether your app collects purchase history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** + +The reasons your app collects purchase history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** + +Indicates whether your app links purchase history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** + +Indicates whether your app uses purchase history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/collected** + +Indicates whether your app collects search history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** + +The reasons your app collects search history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** + +Indicates whether your app links search history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** + +Indicates whether your app uses search history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/collected** + +Indicates whether your app collects sensitive user information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** + +The reasons your app collects sensitive user information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** + +Indicates whether your app links sensitive user information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** + +Indicates whether your app uses sensitive user information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/collected** + +Indicates whether your app collects user IDs. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/user_id/collection_purposes** + +The reasons your app collects user IDs. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/linked_to_user** + +Indicates whether your app links user IDs to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** + +Indicates whether your app uses user IDs for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/disk_space_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/disk_space_access_reasons** + +The reasons your app use free disk space API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/file_timestamp_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/file_timestamp_access_reasons** + +The reasons your app use file timestamp/metadata API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description: .. rst-class:: classref-property @@ -643,6 +2667,56 @@ A message displayed when requesting access to the user's photo library (localize ---- +.. _class_EditorExportPlatformIOS_property_privacy/system_boot_time_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/system_boot_time_access_reasons** + +The reasons your app use system boot time / absolute time API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/tracking_domains: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **privacy/tracking_domains** + +The list of internet domains your app connects to that engage in tracking. See `Privacy manifest files `__. + +**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/tracking_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/tracking_enabled** + +Indicates whether your app uses data for tracking. See `Privacy manifest files `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/user_defaults_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/user_defaults_access_reasons** + +The reasons your app use user defaults API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color: .. rst-class:: classref-property diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 1f8760582..a21d5ee2b 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -389,6 +389,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/default_property_name_style` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/delimitate_all_container_and_resources` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/disable_folding` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | @@ -399,6 +401,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/nested_color_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/open_resources_in_current_inspector` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`interface/inspector/resources_to_open_in_new_inspector` | @@ -491,6 +495,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`run/output/font_size` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/output/max_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`run/platforms/linuxbsd/prefer_wayland` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`run/window_placement/android_window` | @@ -2899,6 +2905,20 @@ The default property name style to display in the Inspector dock. This style can ---- +.. _class_EditorSettings_property_interface/inspector/delimitate_all_container_and_resources: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/delimitate_all_container_and_resources** + +If ``true``, add a margin around Array, Dictionary, and Resource Editors that are not already colored. + +\ **Note:** If :ref:`interface/inspector/nested_color_mode` is set to **Containers & Resources** this parameter will have no effect since those editors will already be colored + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/disable_folding: .. rst-class:: classref-property @@ -2959,6 +2979,24 @@ The number of :ref:`Array` or :ref:`Dictionary` i ---- +.. _class_EditorSettings_property_interface/inspector/nested_color_mode: + +.. rst-class:: classref-property + +:ref:`int` **interface/inspector/nested_color_mode** + +Control which property editors are colored when they are opened. + +- **Containers & Resources:** Color all Array, Dictionary, and Resource Editors. + +- **Resources:** Color all Resource Editors. + +- **External Resources:** Color Resource Editors that edits an external resource. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/open_resources_in_current_inspector: .. rst-class:: classref-property @@ -3389,7 +3427,7 @@ All update modes will ignore builds with different major versions (e.g. Godot 4 :ref:`int` **network/connection/network_mode** -Determines whether online features are enabled in the editor, such as the Asset Library or update checks. Disabling these online features helps alleviate privacy concerns by preventing the editor from making HTTP requests to the Godot website, GitHub, or third-party platforms hosting assets from the Asset Library. +Determines whether online features are enabled in the editor, such as the Asset Library or update checks. Disabling these online features helps alleviate privacy concerns by preventing the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Library. .. rst-class:: classref-item-separator @@ -3555,6 +3593,18 @@ The size of the font in the **Output** panel at the bottom of the editor. This s ---- +.. _class_EditorSettings_property_run/output/max_lines: + +.. rst-class:: classref-property + +:ref:`int` **run/output/max_lines** + +Maximum number of lines to show at any one time in the Output panel. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_run/platforms/linuxbsd/prefer_wayland: .. rst-class:: classref-property diff --git a/classes/class_hingejoint3d.rst b/classes/class_hingejoint3d.rst index 03db5a9ba..21c4895e3 100644 --- a/classes/class_hingejoint3d.rst +++ b/classes/class_hingejoint3d.rst @@ -122,9 +122,7 @@ The speed with which the rotation across the axis perpendicular to the hinge get :ref:`Param` **PARAM_LIMIT_SOFTNESS** = ``4`` -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! +**Deprecated:** This property is never used by the engine and is kept for compatibility purpose. @@ -282,9 +280,7 @@ The lower this value, the more the rotation gets slowed down. - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +**Deprecated:** This property is never set by the engine and is kept for compatibility purposes. .. rst-class:: classref-item-separator diff --git a/classes/class_input.rst b/classes/class_input.rst index 0a4989244..381fc5627 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -149,7 +149,7 @@ Methods +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`stop_joy_vibration`\ (\ device\: :ref:`int`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`vibrate_handheld`\ (\ duration_ms\: :ref:`int` = 500\ ) | + | |void| | :ref:`vibrate_handheld`\ (\ duration_ms\: :ref:`int` = 500, amplitude\: :ref:`float` = -1.0\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2`\ ) | +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1113,7 +1113,9 @@ Stops the vibration of the joypad started with :ref:`start_joy_vibration` = 500\ ) +|void| **vibrate_handheld**\ (\ duration_ms\: :ref:`int` = 500, amplitude\: :ref:`float` = -1.0\ ) + +**Note:** While ``amplitude`` expects a value between 0 and 1, -1 does the default amplitude for the device. Vibrate the handheld device for the specified duration in milliseconds. @@ -1123,6 +1125,8 @@ Vibrate the handheld device for the specified duration in milliseconds. \ **Note:** For iOS, specifying the duration is only supported in iOS 13 and later. +\ **Note:** For Web, the amplitude cannot be changed. + \ **Note:** Some web browsers such as Safari and Firefox for Android do not support :ref:`vibrate_handheld`. .. rst-class:: classref-item-separator diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 0a48c51ad..571ec5a4e 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -52,6 +52,8 @@ Properties +----------------------------------------------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`k2` | ``0.215`` | +----------------------------------------------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`offset_rect` | ``Rect2(0, 0, 1, 1)`` | + +----------------------------------------------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`oversample` | ``1.5`` | +----------------------------------------------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | :ref:`PlayAreaMode` | xr_play_area_mode | ``1`` (overrides :ref:`XRInterface`) | @@ -168,6 +170,23 @@ The k2 lens factor, see k1. ---- +.. _class_MobileVRInterface_property_offset_rect: + +.. rst-class:: classref-property + +:ref:`Rect2` **offset_rect** = ``Rect2(0, 0, 1, 1)`` + +.. rst-class:: classref-property-setget + +- |void| **set_offset_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_offset_rect**\ (\ ) + +Set the offset rect relative to the area being rendered. A length of 1 represents the whole rendering area on that axis. + +.. rst-class:: classref-item-separator + +---- + .. _class_MobileVRInterface_property_oversample: .. rst-class:: classref-property diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 89387e742..66b4bf380 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -378,7 +378,9 @@ Adds the ``offset`` vector to the node's global position. |void| **look_at**\ (\ point\: :ref:`Vector2`\ ) -Rotates the node so it points towards the ``point``, which is expected to use global coordinates. +Rotates the node so that its local +X axis points towards the ``point``, which is expected to use global coordinates. + +\ ``point`` should not be the same as the node's position, otherwise the node always looks to the right. .. rst-class:: classref-item-separator diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index 223e42687..03390fcbe 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -65,6 +65,8 @@ Methods +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_play_space`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_predicted_display_time`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_session`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_swapchain_format_name`\ (\ swapchain_format\: :ref:`int`\ ) | @@ -206,7 +208,7 @@ Returns the function pointer of the OpenXR function with the specified name, cas :ref:`int` **get_next_frame_time**\ (\ ) -Returns the timing for the next frame. +Returns the predicted display timing for the next frame. .. rst-class:: classref-item-separator @@ -224,6 +226,18 @@ Returns the play space, which is an `XrSpace ` **get_predicted_display_time**\ (\ ) + +Returns the predicted display timing for the current frame. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_get_session: .. rst-class:: classref-method diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index 67fdc8cfd..24f48370c 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -83,6 +83,8 @@ Methods +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_foveation_supported`\ (\ ) |const| | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_hand_interaction_supported`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_hand_tracking_supported`\ (\ ) | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_action_set_active`\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) | @@ -99,6 +101,18 @@ Methods Signals ------- +.. _class_OpenXRInterface_signal_instance_exiting: + +.. rst-class:: classref-signal + +**instance_exiting**\ (\ ) + +Informs our OpenXR instance is exiting. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_signal_pose_recentered: .. rst-class:: classref-signal @@ -149,6 +163,18 @@ Informs our OpenXR session now has focus. ---- +.. _class_OpenXRInterface_signal_session_loss_pending: + +.. rst-class:: classref-signal + +**session_loss_pending**\ (\ ) + +Informs our OpenXR session is in the process of being lost. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_signal_session_stopping: .. rst-class:: classref-signal @@ -836,6 +862,20 @@ Returns ``true`` if OpenXR's foveation extension is supported, the interface mus ---- +.. _class_OpenXRInterface_method_is_hand_interaction_supported: + +.. rst-class:: classref-method + +:ref:`bool` **is_hand_interaction_supported**\ (\ ) |const| + +Returns ``true`` if OpenXR's hand interaction profile is supported and enabled. + +\ **Note:** This only returns a valid value after OpenXR has been initialized. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_method_is_hand_tracking_supported: .. rst-class:: classref-method diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 273dc27a0..fb01afb45 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -208,7 +208,7 @@ Property Descriptions A dictionary representation of the scene contents. -Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for paths to overridden nodes, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. +Available keys include "names" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for paths to overridden nodes, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. .. rst-class:: classref-section-separator @@ -261,7 +261,7 @@ Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). :ref:`Error` **pack**\ (\ path\: :ref:`Node`\ ) -Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner`. +Packs the ``path`` node, and all owned sub-nodes, into this **PackedScene**. Any existing data will be cleared. See :ref:`Node.owner`. .. |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_packedvector4array.rst b/classes/class_packedvector4array.rst new file mode 100644 index 000000000..8c5afb1c7 --- /dev/null +++ b/classes/class_packedvector4array.rst @@ -0,0 +1,492 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector4Array.xml. + +.. _class_PackedVector4Array: + +PackedVector4Array +================== + +A packed array of :ref:`Vector4`\ s. + +.. rst-class:: classref-introduction-group + +Description +----------- + +An array specifically designed to hold :ref:`Vector4`. Packs data tightly, so it saves memory for large array sizes. + +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. + +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + +.. rst-class:: classref-reftable-group + +Constructors +------------ + +.. table:: + :widths: auto + + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`PackedVector4Array`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`PackedVector4Array`\ (\ from\: :ref:`PackedVector4Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`PackedVector4Array`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector4Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector4`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector4`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Operators +--------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedVector4Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`operator +`\ (\ right\: :ref:`PackedVector4Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedVector4Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Constructor Descriptions +------------------------ + +.. _class_PackedVector4Array_constructor_PackedVector4Array: + +.. rst-class:: classref-constructor + +:ref:`PackedVector4Array` **PackedVector4Array**\ (\ ) + +Constructs an empty **PackedVector4Array**. + +.. rst-class:: classref-item-separator + +---- + +.. rst-class:: classref-constructor + +:ref:`PackedVector4Array` **PackedVector4Array**\ (\ from\: :ref:`PackedVector4Array`\ ) + +Constructs a **PackedVector4Array** as a copy of the given **PackedVector4Array**. + +.. rst-class:: classref-item-separator + +---- + +.. rst-class:: classref-constructor + +:ref:`PackedVector4Array` **PackedVector4Array**\ (\ from\: :ref:`Array`\ ) + +Constructs a new **PackedVector4Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +\ **Note:** When initializing a **PackedVector4Array** with elements, it must be initialized with an :ref:`Array` of :ref:`Vector4` values: + +:: + + var array = PackedVector4Array([Vector4(12, 34, 56, 78), Vector4(90, 12, 34, 56)]) + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_PackedVector4Array_method_append: + +.. rst-class:: classref-method + +:ref:`bool` **append**\ (\ value\: :ref:`Vector4`\ ) + +Appends an element at the end of the array (alias of :ref:`push_back`). + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_append_array: + +.. rst-class:: classref-method + +|void| **append_array**\ (\ array\: :ref:`PackedVector4Array`\ ) + +Appends a **PackedVector4Array** at the end of this array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_bsearch: + +.. rst-class:: classref-method + +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) + +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. + +\ **Note:** Calling :ref:`bsearch` on an unsorted array results in unexpected behavior. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_clear: + +.. rst-class:: classref-method + +|void| **clear**\ (\ ) + +Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_count: + +.. rst-class:: classref-method + +:ref:`int` **count**\ (\ value\: :ref:`Vector4`\ ) |const| + +Returns the number of times an element is in the array. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_duplicate: + +.. rst-class:: classref-method + +:ref:`PackedVector4Array` **duplicate**\ (\ ) + +Creates a copy of the array, and returns it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_fill: + +.. rst-class:: classref-method + +|void| **fill**\ (\ value\: :ref:`Vector4`\ ) + +Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_find: + +.. rst-class:: classref-method + +:ref:`int` **find**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| + +Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_has: + +.. rst-class:: classref-method + +:ref:`bool` **has**\ (\ value\: :ref:`Vector4`\ ) |const| + +Returns ``true`` if the array contains ``value``. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_insert: + +.. rst-class:: classref-method + +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector4`\ ) + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_is_empty: + +.. rst-class:: classref-method + +:ref:`bool` **is_empty**\ (\ ) |const| + +Returns ``true`` if the array is empty. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_push_back: + +.. rst-class:: classref-method + +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector4`\ ) + +Inserts a :ref:`Vector4` at the end. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_remove_at: + +.. rst-class:: classref-method + +|void| **remove_at**\ (\ index\: :ref:`int`\ ) + +Removes an element from the array by index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_resize: + +.. rst-class:: classref-method + +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_reverse: + +.. rst-class:: classref-method + +|void| **reverse**\ (\ ) + +Reverses the order of the elements in the array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_rfind: + +.. rst-class:: classref-method + +:ref:`int` **rfind**\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = -1\ ) |const| + +Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_set: + +.. rst-class:: classref-method + +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector4`\ ) + +Changes the :ref:`Vector4` at the given index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_size: + +.. rst-class:: classref-method + +:ref:`int` **size**\ (\ ) |const| + +Returns the number of elements in the array. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_slice: + +.. rst-class:: classref-method + +:ref:`PackedVector4Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| + +Returns the slice of the **PackedVector4Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector4Array**. + +The absolute value of ``begin`` and ``end`` will be clamped to the array size, so the default value for ``end`` makes it slice to the size of the array by default (i.e. ``arr.slice(1)`` is a shorthand for ``arr.slice(1, arr.size())``). + +If either ``begin`` or ``end`` are negative, they will be relative to the end of the array (i.e. ``arr.slice(0, -2)`` is a shorthand for ``arr.slice(0, arr.size() - 2)``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_sort: + +.. rst-class:: classref-method + +|void| **sort**\ (\ ) + +Sorts the elements of the array in ascending order. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_method_to_byte_array: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| + +Returns a :ref:`PackedByteArray` with each vector encoded as bytes. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Operator Descriptions +--------------------- + +.. _class_PackedVector4Array_operator_neq_PackedVector4Array: + +.. rst-class:: classref-operator + +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector4Array`\ ) + +Returns ``true`` if contents of the arrays differ. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_operator_sum_PackedVector4Array: + +.. rst-class:: classref-operator + +:ref:`PackedVector4Array` **operator +**\ (\ right\: :ref:`PackedVector4Array`\ ) + +Returns a new **PackedVector4Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_operator_eq_PackedVector4Array: + +.. rst-class:: classref-operator + +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector4Array`\ ) + +Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector4`\ s at the corresponding indices. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedVector4Array_operator_idx_int: + +.. rst-class:: classref-operator + +:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) + +Returns the :ref:`Vector4` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. + +.. |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_projectsettings.rst b/classes/class_projectsettings.rst index d12046be7..d46daf83e 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1599,6 +1599,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/extensions/eye_gaze_interaction` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`xr/openxr/extensions/hand_interaction_profile` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/extensions/hand_tracking` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/form_factor` | ``"0"`` | @@ -2074,7 +2076,7 @@ This setting can be overridden using the ``--frame-delay `` command line ar :ref:`bool` **application/run/low_processor_mode** = ``false`` -If ``true``, enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. +If ``true``, enables low-processor usage mode. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. .. rst-class:: classref-item-separator @@ -11711,6 +11713,18 @@ Specify whether to enable eye tracking for this project. Depending on the platfo ---- +.. _class_ProjectSettings_property_xr/openxr/extensions/hand_interaction_profile: + +.. rst-class:: classref-property + +:ref:`bool` **xr/openxr/extensions/hand_interaction_profile** = ``false`` + +If true the hand interaction profile extension will be activated if supported by the platform. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_xr/openxr/extensions/hand_tracking: .. rst-class:: classref-property diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 572af49de..2f8ad7171 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -298,14 +298,14 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to var rect = Rect2(0, 0, 5, 2) rect = rect.expand(Vector2(10, 0)) # rect is Rect2(0, 0, 10, 2) - rect = rect.expand(Vector2(-5, 5)) # rect is Rect2(-5, 0, 10, 5) + rect = rect.expand(Vector2(-5, 5)) # rect is Rect2(-5, 0, 15, 5) .. code-tab:: csharp var rect = new Rect2(0, 0, 5, 2); rect = rect.Expand(new Vector2(10, 0)); // rect is Rect2(0, 0, 10, 2) - rect = rect.Expand(new Vector2(-5, 5)); // rect is Rect2(-5, 0, 10, 5) + rect = rect.Expand(new Vector2(-5, 5)); // rect is Rect2(-5, 0, 15, 5) diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index 768fc67be..61d6795e0 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -290,14 +290,14 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to var rect = Rect2i(0, 0, 5, 2) rect = rect.expand(Vector2i(10, 0)) # rect is Rect2i(0, 0, 10, 2) - rect = rect.expand(Vector2i(-5, 5)) # rect is Rect2i(-5, 0, 10, 5) + rect = rect.expand(Vector2i(-5, 5)) # rect is Rect2i(-5, 0, 15, 5) .. code-tab:: csharp var rect = new Rect2I(0, 0, 5, 2); rect = rect.Expand(new Vector2I(10, 0)); // rect is Rect2I(0, 0, 10, 2) - rect = rect.Expand(new Vector2I(-5, 5)); // rect is Rect2I(-5, 0, 10, 5) + rect = rect.Expand(new Vector2I(-5, 5)); // rect is Rect2I(-5, 0, 15, 5) diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 3593609e9..c00da234f 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -507,6 +507,8 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_render_thread`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_directional_set_blend_splits`\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_directional_set_shadow_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) | @@ -8564,6 +8566,18 @@ Returns an array of object IDs intersecting with the provided 3D ray. Only 3D no ---- +.. _class_RenderingServer_method_is_on_render_thread: + +.. rst-class:: classref-method + +:ref:`bool` **is_on_render_thread**\ (\ ) + +Returns ``true`` if our code is currently executing on the rendering thread. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_light_directional_set_blend_splits: .. rst-class:: classref-method diff --git a/classes/class_resourceimporterwav.rst b/classes/class_resourceimporterwav.rst index d65a48e04..096a261c1 100644 --- a/classes/class_resourceimporterwav.rst +++ b/classes/class_resourceimporterwav.rst @@ -79,6 +79,8 @@ The compression mode to use on import. \ **RAM (Ima-ADPCM):** Performs fast lossy compression on import. Low CPU cost, but quality is noticeably decreased compared to Ogg Vorbis or even MP3. +\ **QOA (`Quite OK Audio `__):** Performs lossy compression on import. CPU cost is slightly higher than IMA-ADPCM, but quality is much higher. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index a44b60d86..551ef6d87 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -155,6 +155,8 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`install_effect`\ (\ effect\: :ref:`Variant`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`invalidate_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ready`\ (\ ) |const| | @@ -223,7 +225,7 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`push_underline`\ (\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scroll_to_line`\ (\ line\: :ref:`int`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1387,6 +1389,18 @@ Registering the above effect in RichTextLabel from script: ---- +.. _class_RichTextLabel_method_invalidate_paragraph: + +.. rst-class:: classref-method + +:ref:`bool` **invalidate_paragraph**\ (\ paragraph\: :ref:`int`\ ) + +Invalidates ``paragraph`` and all subsequent paragraphs cache. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_is_menu_visible: .. rst-class:: classref-method @@ -1805,12 +1819,14 @@ Adds a ``[u]`` tag to the tag stack. .. rst-class:: classref-method -:ref:`bool` **remove_paragraph**\ (\ paragraph\: :ref:`int`\ ) +:ref:`bool` **remove_paragraph**\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) Removes a paragraph of content from the label. Returns ``true`` if the paragraph exists. The ``paragraph`` argument is the index of the paragraph to remove, it can take values in the interval ``[0, get_paragraph_count() - 1]``. +If ``no_invalidate`` is set to ``true``, cache for the subsequent paragraphs is not invalidated. Use it for faster updates if deleted paragraph is fully self-contained (have no unclosed tags), or this call is part of the complex edit operation and :ref:`invalidate_paragraph` will be called at the end of operation. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_statusindicator.rst b/classes/class_statusindicator.rst index 7b39b585f..50f751e1c 100644 --- a/classes/class_statusindicator.rst +++ b/classes/class_statusindicator.rst @@ -27,13 +27,27 @@ Properties .. table:: :widths: auto - +-----------------------------+--------------------------------------------------------+----------+ - | :ref:`Image` | :ref:`icon` | | - +-----------------------------+--------------------------------------------------------+----------+ - | :ref:`String` | :ref:`tooltip` | ``""`` | - +-----------------------------+--------------------------------------------------------+----------+ - | :ref:`bool` | :ref:`visible` | ``true`` | - +-----------------------------+--------------------------------------------------------+----------+ + +-----------------------------------+--------------------------------------------------------+------------------+ + | :ref:`Texture2D` | :ref:`icon` | | + +-----------------------------------+--------------------------------------------------------+------------------+ + | :ref:`NodePath` | :ref:`menu` | ``NodePath("")`` | + +-----------------------------------+--------------------------------------------------------+------------------+ + | :ref:`String` | :ref:`tooltip` | ``""`` | + +-----------------------------------+--------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`visible` | ``true`` | + +-----------------------------------+--------------------------------------------------------+------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------+----------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_rect`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -65,12 +79,12 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Image` **icon** +:ref:`Texture2D` **icon** .. rst-class:: classref-property-setget -- |void| **set_icon**\ (\ value\: :ref:`Image`\ ) -- :ref:`Image` **get_icon**\ (\ ) +- |void| **set_icon**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_icon**\ (\ ) Status indicator icon. @@ -78,6 +92,25 @@ Status indicator icon. ---- +.. _class_StatusIndicator_property_menu: + +.. rst-class:: classref-property + +:ref:`NodePath` **menu** = ``NodePath("")`` + +.. rst-class:: classref-property-setget + +- |void| **set_menu**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_menu**\ (\ ) + +Status indicator native popup menu. If this is set, the :ref:`pressed` signal is not emitted. + +\ **Note:** Native popup is only supported if :ref:`NativeMenu` supports :ref:`NativeMenu.FEATURE_POPUP_MENU` feature. + +.. rst-class:: classref-item-separator + +---- + .. _class_StatusIndicator_property_tooltip: .. rst-class:: classref-property @@ -108,6 +141,23 @@ Status indicator tooltip. If ``true``, the status indicator is visible. +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_StatusIndicator_method_get_rect: + +.. rst-class:: classref-method + +:ref:`Rect2` **get_rect**\ (\ ) |const| + +Returns the status indicator rectangle in screen coordinates. If this status indicator is not visible, returns an empty :ref:`Rect2`. + .. |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_string.rst b/classes/class_string.rst index 6d23cd8f5..b73d0a829 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1511,7 +1511,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with :ref:`String` **reverse**\ (\ ) |const| -Returns the copy of this string in reverse order. +Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis. .. rst-class:: classref-item-separator diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index dbbd79cf9..7b85e7d0b 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -1347,7 +1347,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with :ref:`String` **reverse**\ (\ ) |const| -Returns the copy of this string in reverse order. +Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis. .. rst-class:: classref-item-separator diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6bc4c5def..9e971dc54 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -26,7 +26,7 @@ Description A multiline text editor. It also has limited facilities for editing code, such as syntax highlighting support. For more advanced facilities for editing code, see :ref:`CodeEdit`. -\ **Note:** Most viewport, caret and edit methods contain a ``caret_index`` argument for :ref:`caret_multiple` support. The argument should be one of the following: ``-1`` for all carets, ``0`` for the main caret, or greater than ``0`` for secondary carets. +\ **Note:** Most viewport, caret, and edit methods contain a ``caret_index`` argument for :ref:`caret_multiple` support. The argument should be one of the following: ``-1`` for all carets, ``0`` for the main caret, or greater than ``0`` for secondary carets in the order they were created. \ **Note:** When holding down :kbd:`Alt`, the vertical scroll wheel will scroll 5 times as fast as it would normally do. This also works in the Godot script editor. @@ -130,291 +130,321 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_backspace`\ (\ caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_copy`\ (\ caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_cut`\ (\ caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_handle_unicode_input`\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_paste`\ (\ caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_paste_primary_clipboard`\ (\ caret_index\: :ref:`int`\ ) |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_caret`\ (\ line\: :ref:`int`, col\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_caret_at_carets`\ (\ below\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_gutter`\ (\ at\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_selection_for_next_occurrence`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`adjust_carets_after_edit`\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`adjust_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`apply_ime`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`backspace`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`begin_complex_operation`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cancel_ime`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`center_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_undo_history`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`copy`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cut`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`delete_selection`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`end_action`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`end_complex_operation`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_count`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_caret_draw_pos`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_caret_index_edit_order`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_wrap_index`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_first_non_whitespace_column`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_first_visible_line`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_gutter_count`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_gutter_name`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GutterType` | :ref:`get_gutter_type`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_gutter_width`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HScrollBar` | :ref:`get_h_scroll_bar`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_indent_level`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_full_visible_line`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_full_visible_line_wrap_index`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_unhidden_line`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_line`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_line_background_color`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_column_at_pos`\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_height`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_width`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_wrap_count`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_wrap_index_at_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_line_wrapped_text`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_local_mouse_pos`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_minimap_line_at_pos`\ (\ position\: :ref:`Vector2i`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_minimap_visible_lines`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_next_visible_line_index_offset_from`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_visible_line_offset_from`\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_pos_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_rect_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_saved_version`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_scroll_pos_for_line`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SelectionMode` | :ref:`get_selection_mode`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_size`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_gutter_width`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_visible_line_count`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_version`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count_in_range`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_word_at_pos`\ (\ position\: :ref:`Vector2`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selection`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`insert_line_at`\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_caret_visible`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dragging_cursor`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_clickable`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_drawn`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_overwritable`\ (\ gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_wrapped`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_mouse_over_selection`\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_overtype_mode_enabled`\ (\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`merge_gutters`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`merge_overlapping_carets`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`paste`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`paste_primary_clipboard`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`redo`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_caret`\ (\ caret\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_gutter`\ (\ gutter\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_secondary_carets`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_text`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`search`\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_colum\: :ref:`int`\ ) |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select_all`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_caret_column`\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_caret_line`\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_clickable`\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_custom_draw`\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_draw`\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_name`\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_overwritable`\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_type`\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gutter_width`\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line`\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_as_center_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_as_first_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_as_last_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_background_color`\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_overtype_mode_enabled`\ (\ enabled\: :ref:`bool`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_search_flags`\ (\ flags\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_search_text`\ (\ search_text\: :ref:`String`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_selection_mode`\ (\ mode\: :ref:`SelectionMode`, line\: :ref:`int` = -1, column\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tab_size`\ (\ size\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tooltip_request_func`\ (\ callback\: :ref:`Callable`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`skip_selection_for_next_occurrence`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`start_action`\ (\ action\: :ref:`EditAction`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`swap_lines`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tag_saved_version`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`undo`\ (\ ) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_backspace`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_copy`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cut`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_handle_unicode_input`\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_paste`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_paste_primary_clipboard`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_caret`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_caret_at_carets`\ (\ below\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_gutter`\ (\ at\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_selection_for_next_occurrence`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`adjust_carets_after_edit`\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`adjust_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_ime`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`backspace`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_complex_operation`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_multicaret_edit`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_ime`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`center_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_undo_history`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`collapse_carets`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, inclusive\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`copy`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cut`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_selection`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_action`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_complex_operation`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_multicaret_edit`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_count`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_caret_draw_pos`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_caret_index_edit_order`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_wrap_index`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_first_non_whitespace_column`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_first_visible_line`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_gutter_count`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_gutter_name`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GutterType` | :ref:`get_gutter_type`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_gutter_width`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HScrollBar` | :ref:`get_h_scroll_bar`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_indent_level`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_full_visible_line`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_full_visible_line_wrap_index`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_unhidden_line`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_line`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_line_background_color`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_column_at_pos`\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_height`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_line_ranges_from_carets`\ (\ only_selections\: :ref:`bool` = false, merge_adjacent\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_width`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_wrap_count`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_wrap_index_at_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_line_wrapped_text`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_local_mouse_pos`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_minimap_line_at_pos`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_minimap_visible_lines`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_next_visible_line_index_offset_from`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_visible_line_offset_from`\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_pos_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_rect_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_saved_version`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_scroll_pos_for_line`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`, include_edges\: :ref:`bool` = true, only_selections\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SelectionMode` | :ref:`get_selection_mode`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_origin_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_origin_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_sorted_carets`\ (\ include_ignored_carets\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_size`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_gutter_width`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_visible_line_count`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_version`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count_in_range`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_word_at_pos`\ (\ position\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selection`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_line_at`\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_text`\ (\ text\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`, before_selection_begin\: :ref:`bool` = true, before_selection_end\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_caret_after_selection_origin`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_caret_visible`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dragging_cursor`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_clickable`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_drawn`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_overwritable`\ (\ gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_mulitcaret_edit`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_wrapped`\ (\ line\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_mouse_over_selection`\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_overtype_mode_enabled`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge_gutters`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge_overlapping_carets`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`multicaret_edit_ignore_caret`\ (\ caret_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`paste`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`paste_primary_clipboard`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`redo`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_caret`\ (\ caret\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_gutter`\ (\ gutter\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_line_at`\ (\ line\: :ref:`int`, move_carets_down\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_secondary_carets`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_text`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`search`\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_column\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ origin_line\: :ref:`int`, origin_column\: :ref:`int`, caret_line\: :ref:`int`, caret_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_caret_column`\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_caret_line`\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_clickable`\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_custom_draw`\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_draw`\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_name`\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_overwritable`\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_type`\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_width`\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line`\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_center_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_first_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_last_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_background_color`\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_overtype_mode_enabled`\ (\ enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_search_flags`\ (\ flags\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_search_text`\ (\ search_text\: :ref:`String`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selection_mode`\ (\ mode\: :ref:`SelectionMode`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selection_origin_column`\ (\ column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selection_origin_line`\ (\ line\: :ref:`int`, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_size`\ (\ size\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tooltip_request_func`\ (\ callback\: :ref:`Callable`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skip_selection_for_next_occurrence`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_action`\ (\ action\: :ref:`EditAction`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`swap_lines`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tag_saved_version`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`undo`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -487,7 +517,7 @@ Signals **caret_changed**\ (\ ) -Emitted when the caret changes position. +Emitted when any caret changes position. .. rst-class:: classref-item-separator @@ -1232,7 +1262,7 @@ If ``true``, the selected text will be deselected when focus is lost. - |void| **set_drag_and_drop_selection_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_drag_and_drop_selection_enabled**\ (\ ) -If ``true``, allow drag and drop of selected text. +If ``true``, allow drag and drop of selected text. Text can still be dropped from other sources. .. rst-class:: classref-item-separator @@ -1784,7 +1814,7 @@ Override this method to define what happens when the user performs a paste opera .. rst-class:: classref-method -:ref:`int` **add_caret**\ (\ line\: :ref:`int`, col\: :ref:`int`\ ) +:ref:`int` **add_caret**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) Adds a new caret at the given location. Returns the index of the new caret, or ``-1`` if the location is invalid. @@ -1798,7 +1828,7 @@ Adds a new caret at the given location. Returns the index of the new caret, or ` |void| **add_caret_at_carets**\ (\ below\: :ref:`bool`\ ) -Adds an additional caret above or below every caret. If ``below`` is true the new caret will be added below and above otherwise. +Adds an additional caret above or below every caret. If ``below`` is ``true`` the new caret will be added below and above otherwise. .. rst-class:: classref-item-separator @@ -1834,7 +1864,9 @@ Adds a selection and a caret for the next occurrence of the current selection. I |void| **adjust_carets_after_edit**\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) -Reposition the carets affected by the edit. This assumes edits are applied in edit order, see :ref:`get_caret_index_edit_order`. +**Deprecated:** No longer necessary since methods now adjust carets themselves. + +This method does nothing. .. rst-class:: classref-item-separator @@ -1888,6 +1920,31 @@ Starts a multipart edit. All edits will be treated as one action until :ref:`end ---- +.. _class_TextEdit_method_begin_multicaret_edit: + +.. rst-class:: classref-method + +|void| **begin_multicaret_edit**\ (\ ) + +Starts an edit for multiple carets. The edit must be ended with :ref:`end_multicaret_edit`. Multicaret edits can be used to edit text at multiple carets and delay merging the carets until the end, so the caret indexes aren't affected immediately. :ref:`begin_multicaret_edit` and :ref:`end_multicaret_edit` can be nested, and the merge will happen at the last :ref:`end_multicaret_edit`. + +Example usage: + +:: + + begin_complex_operation() + begin_multicaret_edit() + for i in range(get_caret_count()): + if multicaret_edit_ignore_caret(i): + continue + # Logic here. + end_multicaret_edit() + end_complex_operation() + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_cancel_ime: .. rst-class:: classref-method @@ -1936,6 +1993,24 @@ Clears the undo history. ---- +.. _class_TextEdit_method_collapse_carets: + +.. rst-class:: classref-method + +|void| **collapse_carets**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, inclusive\: :ref:`bool` = false\ ) + +Collapse all carets in the given range to the ``from_line`` and ``from_column`` position. + +\ ``inclusive`` applies to both ends. + +If :ref:`is_in_mulitcaret_edit` is ``true``, carets that are collapsed will be ``true`` for :ref:`multicaret_edit_ignore_caret`. + +\ :ref:`merge_overlapping_carets` will be called if any carets were collapsed. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_copy: .. rst-class:: classref-method @@ -2008,6 +2083,18 @@ Ends a multipart edit, started with :ref:`begin_complex_operation`. If this was the last :ref:`end_multicaret_edit` and :ref:`merge_overlapping_carets` was called, carets will be merged. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_caret_column: .. rst-class:: classref-method @@ -2050,6 +2137,8 @@ Returns the caret pixel draw position. :ref:`PackedInt32Array` **get_caret_index_edit_order**\ (\ ) +**Deprecated:** Carets no longer need to be edited in any specific order. If the carets need to be sorted, use :ref:`get_sorted_carets` instead. + Returns a list of caret indexes in their edit order, this done from bottom to top. Edit order refers to the way actions such as :ref:`insert_text_at_caret` are applied. .. rst-class:: classref-item-separator @@ -2322,6 +2411,20 @@ Returns the maximum value of the line height among all lines. ---- +.. _class_TextEdit_method_get_line_ranges_from_carets: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Vector2i`\] **get_line_ranges_from_carets**\ (\ only_selections\: :ref:`bool` = false, merge_adjacent\: :ref:`bool` = true\ ) |const| + +Returns an :ref:`Array` of line ranges where ``x`` is the first line and ``y`` is the last line. All lines within these ranges will have a caret on them or be part of a selection. Each line will only be part of one line range, even if it has multiple carets on it. + +If a selection's end column (:ref:`get_selection_to_column`) is at column ``0``, that line will not be included. If a selection begins on the line after another selection ends and ``merge_adjacent`` is ``true``, or they begin and end on the same line, one line range will include both selections. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_line_width: .. rst-class:: classref-method @@ -2553,12 +2656,28 @@ Returns the text inside the selection of a caret, or all the carets if ``caret_i ---- +.. _class_TextEdit_method_get_selection_at_line_column: + +.. rst-class:: classref-method + +:ref:`int` **get_selection_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`, include_edges\: :ref:`bool` = true, only_selections\: :ref:`bool` = true\ ) |const| + +Returns the caret index of the selection at the given ``line`` and ``column``, or ``-1`` if there is none. + +If ``include_edges`` is ``false``, the position must be inside the selection and not at either end. If ``only_selections`` is ``false``, carets without a selection will also be considered. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_selection_column: .. rst-class:: classref-method :ref:`int` **get_selection_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +**Deprecated:** Use :ref:`get_selection_origin_column` instead. + Returns the original start column of the selection. .. rst-class:: classref-item-separator @@ -2571,7 +2690,7 @@ Returns the original start column of the selection. :ref:`int` **get_selection_from_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| -Returns the selection begin column. +Returns the selection begin column. Returns the caret column if there is no selection. .. rst-class:: classref-item-separator @@ -2583,7 +2702,7 @@ Returns the selection begin column. :ref:`int` **get_selection_from_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| -Returns the selection begin line. +Returns the selection begin line. Returns the caret line if there is no selection. .. rst-class:: classref-item-separator @@ -2595,6 +2714,8 @@ Returns the selection begin line. :ref:`int` **get_selection_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| +**Deprecated:** Use :ref:`get_selection_origin_line` instead. + Returns the original start line of the selection. .. rst-class:: classref-item-separator @@ -2613,13 +2734,37 @@ Returns the current selection mode. ---- +.. _class_TextEdit_method_get_selection_origin_column: + +.. rst-class:: classref-method + +:ref:`int` **get_selection_origin_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| + +Returns the origin column of the selection. This is the opposite end from the caret. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_method_get_selection_origin_line: + +.. rst-class:: classref-method + +:ref:`int` **get_selection_origin_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| + +Returns the origin line of the selection. This is the opposite end from the caret. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_get_selection_to_column: .. rst-class:: classref-method :ref:`int` **get_selection_to_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| -Returns the selection end column. +Returns the selection end column. Returns the caret column if there is no selection. .. rst-class:: classref-item-separator @@ -2631,7 +2776,21 @@ Returns the selection end column. :ref:`int` **get_selection_to_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| -Returns the selection end line. +Returns the selection end line. Returns the caret line if there is no selection. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_method_get_sorted_carets: + +.. rst-class:: classref-method + +:ref:`PackedInt32Array` **get_sorted_carets**\ (\ include_ignored_carets\: :ref:`bool` = false\ ) |const| + +Returns the carets sorted by selection beginning from lowest line and column to highest (from top to bottom of text). + +If ``include_ignored_carets`` is ``false``, carets from :ref:`multicaret_edit_ignore_caret` will be ignored. .. rst-class:: classref-item-separator @@ -2805,6 +2964,22 @@ Inserts a new line with ``text`` at ``line``. ---- +.. _class_TextEdit_method_insert_text: + +.. rst-class:: classref-method + +|void| **insert_text**\ (\ text\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`, before_selection_begin\: :ref:`bool` = true, before_selection_end\: :ref:`bool` = false\ ) + +Inserts the ``text`` at ``line`` and ``column``. + +If ``before_selection_begin`` is ``true``, carets and selections that begin at ``line`` and ``column`` will moved to the end of the inserted text, along with all carets after it. + +If ``before_selection_end`` is ``true``, selections that end at ``line`` and ``column`` will be extended to the end of the inserted text. These parameters can be used to insert text inside of or outside of selections. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_insert_text_at_caret: .. rst-class:: classref-method @@ -2817,6 +2992,18 @@ Insert the specified text at the caret position. ---- +.. _class_TextEdit_method_is_caret_after_selection_origin: + +.. rst-class:: classref-method + +:ref:`bool` **is_caret_after_selection_origin**\ (\ caret_index\: :ref:`int` = 0\ ) |const| + +Returns ``true`` if the caret of the selection is after the selection origin. This can be used to determine the direction of the selection. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_is_caret_visible: .. rst-class:: classref-method @@ -2835,7 +3022,7 @@ Returns ``true`` if the caret is visible on the screen. :ref:`bool` **is_dragging_cursor**\ (\ ) |const| -Returns ``true`` if the user is dragging their mouse for scrolling or selecting. +Returns ``true`` if the user is dragging their mouse for scrolling, selecting, or text dragging. .. rst-class:: classref-item-separator @@ -2877,6 +3064,18 @@ Returns whether the gutter is overwritable. ---- +.. _class_TextEdit_method_is_in_mulitcaret_edit: + +.. rst-class:: classref-method + +:ref:`bool` **is_in_mulitcaret_edit**\ (\ ) |const| + +Returns ``true`` if a :ref:`begin_multicaret_edit` has been called and :ref:`end_multicaret_edit` has not yet been called. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_is_line_gutter_clickable: .. rst-class:: classref-method @@ -2969,12 +3168,28 @@ Merge the gutters from ``from_line`` into ``to_line``. Only overwritable gutters Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. +If :ref:`is_in_mulitcaret_edit` is ``true``, the merge will be queued to happen at the end of the multicaret edit. See :ref:`begin_multicaret_edit` and :ref:`end_multicaret_edit`. + \ **Note:** This is not called when a caret changes position but after certain actions, so it is possible to get into a state where carets overlap. .. rst-class:: classref-item-separator ---- +.. _class_TextEdit_method_multicaret_edit_ignore_caret: + +.. rst-class:: classref-method + +:ref:`bool` **multicaret_edit_ignore_caret**\ (\ caret_index\: :ref:`int`\ ) |const| + +Returns ``true`` if the given ``caret_index`` should be ignored as part of a multicaret edit. See :ref:`begin_multicaret_edit` and :ref:`end_multicaret_edit`. Carets that should be ignored are ones that were part of removed text and will likely be merged at the end of the edit, or carets that were added during the edit. + +It is recommended to ``continue`` within a loop iterating on multiple carets if a caret should be ignored. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_paste: .. rst-class:: classref-method @@ -3037,6 +3252,20 @@ Removes the gutter from this **TextEdit**. ---- +.. _class_TextEdit_method_remove_line_at: + +.. rst-class:: classref-method + +|void| **remove_line_at**\ (\ line\: :ref:`int`, move_carets_down\: :ref:`bool` = true\ ) + +Removes the line of text at ``line``. Carets on this line will attempt to match their previous visual x position. + +If ``move_carets_down`` is ``true`` carets will move to the next line down, otherwise carets will move up. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_remove_secondary_carets: .. rst-class:: classref-method @@ -3057,8 +3286,6 @@ Removes all additional carets. Removes text between the given positions. -\ **Note:** This does not adjust the caret or selection, which as a result it can end up in an invalid position. - .. rst-class:: classref-item-separator ---- @@ -3067,7 +3294,7 @@ Removes text between the given positions. .. rst-class:: classref-method -:ref:`Vector2i` **search**\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_colum\: :ref:`int`\ ) |const| +:ref:`Vector2i` **search**\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_column\: :ref:`int`\ ) |const| Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags` enum. @@ -3104,12 +3331,14 @@ In the returned vector, ``x`` is the column, ``y`` is the line. If no results ar .. rst-class:: classref-method -|void| **select**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) +|void| **select**\ (\ origin_line\: :ref:`int`, origin_column\: :ref:`int`, caret_line\: :ref:`int`, caret_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) -Perform selection, from line/column to line/column. +Selects text from ``origin_line`` and ``origin_column`` to ``caret_line`` and ``caret_column`` for the given ``caret_index``. This moves the selection origin and the caret. If the positions are the same, the selection will be deselected. If :ref:`selecting_enabled` is ``false``, no selection will occur. +\ **Note:** If supporting multiple carets this will not check for any overlap. See :ref:`merge_overlapping_carets`. + .. rst-class:: classref-item-separator ---- @@ -3162,12 +3391,14 @@ If ``adjust_viewport`` is ``true``, the viewport will center at the caret positi |void| **set_caret_line**\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) -Moves the caret to the specified ``line`` index. +Moves the caret to the specified ``line`` index. The caret column will be moved to the same visual position it was at the last time :ref:`set_caret_column` was called, or clamped to the end of the line. If ``adjust_viewport`` is ``true``, the viewport will center at the caret position after the move occurs. If ``can_be_hidden`` is ``true``, the specified ``line`` can be hidden. +If ``wrap_index`` is ``-1``, the caret column will be clamped to the ``line``'s length. If ``wrap_index`` is greater than ``-1``, the column will be moved to attempt to match the visual x position on the line's ``wrap_index`` to the position from the last time :ref:`set_caret_column` was called. + \ **Note:** If supporting multiple carets this will not check for any overlap. See :ref:`merge_overlapping_carets`. .. rst-class:: classref-item-separator @@ -3264,7 +3495,9 @@ Set the width of the gutter. |void| **set_line**\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) -Sets the text for a specific line. +Sets the text for a specific ``line``. + +Carets on the line will attempt to keep their visual x position. .. rst-class:: classref-item-separator @@ -3418,7 +3651,7 @@ Sets the search text. See :ref:`set_search_flags`, line\: :ref:`int` = -1, column\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) +|void| **set_selection_mode**\ (\ mode\: :ref:`SelectionMode`\ ) Sets the current selection mode. @@ -3426,6 +3659,34 @@ Sets the current selection mode. ---- +.. _class_TextEdit_method_set_selection_origin_column: + +.. rst-class:: classref-method + +|void| **set_selection_origin_column**\ (\ column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) + +Sets the selection origin column to the ``column`` for the given ``caret_index``. If the selection origin is moved to the caret position, the selection will deselect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_method_set_selection_origin_line: + +.. rst-class:: classref-method + +|void| **set_selection_origin_line**\ (\ line\: :ref:`int`, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) + +Sets the selection origin line to the ``line`` for the given ``caret_index``. If the selection origin is moved to the caret position, the selection will deselect. + +If ``can_be_hidden`` is ``false``, The line will be set to the nearest unhidden line below or above. + +If ``wrap_index`` is ``-1``, the selection origin column will be clamped to the ``line``'s length. If ``wrap_index`` is greater than ``-1``, the column will be moved to attempt to match the visual x position on the line's ``wrap_index`` to the position from the last time :ref:`set_selection_origin_column` or :ref:`select` was called. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_method_set_tab_size: .. rst-class:: classref-method @@ -3482,7 +3743,7 @@ An action will also end after a call to :ref:`end_action`, to_line\: :ref:`int`\ ) -Swaps the two lines. +Swaps the two lines. Carets will be swapped with the lines. .. rst-class:: classref-item-separator diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index fc25400cd..692b542c9 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -296,6 +296,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_identifier`\ (\ string\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`load_support_data`\ (\ filename\: :ref:`String`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`name_to_tag`\ (\ name\: :ref:`String`\ ) |const| | @@ -3207,6 +3209,18 @@ If the :ref:`FEATURE_UNICODE_IDENTIFIERS` **is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |const| + +Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L". + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_load_support_data: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 8962d6df6..0d196e551 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -300,6 +300,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_valid_identifier`\ (\ string\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid_letter`\ (\ unicode\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_load_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_name_to_tag`\ (\ name\: :ref:`String`\ ) |virtual| |const| | @@ -2346,6 +2348,20 @@ Returns ``true`` if ``string`` is a valid identifier. ---- +.. _class_TextServerExtension_private_method__is_valid_letter: + +.. rst-class:: classref-method + +:ref:`bool` **_is_valid_letter**\ (\ unicode\: :ref:`int`\ ) |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__load_support_data: .. rst-class:: classref-method diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 993285931..1ee8aea81 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -184,6 +184,17 @@ Represents cell's horizontal flip flag. Should be used directly with :ref:`TileM # If tile is not already flipped, flip it. $TileMap.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) +\ **Note:** These transformations can be combined to do the equivalent of 0, 90, 180, and 270 degree rotations, as shown below: + +:: + + enum TileTransform { + ROTATE_0 = 0, + ROTATE_90 = TileSetAtlasSource.TRANSFORM_TRANSPOSE | TileSetAtlasSource.TRANSFORM_FLIP_H, + ROTATE_180 = TileSetAtlasSource.TRANSFORM_FLIP_H | TileSetAtlasSource.TRANSFORM_FLIP_V, + ROTATE_270 = TileSetAtlasSource.TRANSFORM_TRANSPOSE | TileSetAtlasSource.TRANSFORM_FLIP_V, + } + .. _class_TileSetAtlasSource_constant_TRANSFORM_FLIP_V: .. rst-class:: classref-constant diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 94420d854..b58d32518 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -68,8 +68,8 @@ The global :ref:`@GlobalScope.typeof` function # Note that Objects are their own special category. # To get the name of the underlying Object type, you need the `get_class()` method. print("foo is a(n) %s" % foo.get_class()) # inject the class name into a formatted string. - # Note also that there is not yet any way to get a script's `class_name` string easily. - # To fetch that value, you can use ProjectSettings.get_global_class_list(). + # Note that this does not get the script's `class_name` global identifier. + # If the `class_name` is needed, use `foo.get_script().get_global_name()` instead. .. code-tab:: csharp diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 475ea51fe..a8abb364d 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -103,6 +103,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`clamp`\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`cross`\ (\ with\: :ref:`Vector2`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | @@ -137,10 +139,18 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`max`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`min`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`move_toward`\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`normalized`\ (\ ) |const| | @@ -167,6 +177,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`snapped`\ (\ step\: :ref:`Vector2`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -514,6 +526,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector2_method_clampf: + +.. rst-class:: classref-method + +:ref:`Vector2` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_cross: .. rst-class:: classref-method @@ -742,6 +766,18 @@ Returns the vector with a maximum length by limiting its length to ``length``. ---- +.. _class_Vector2_method_max: + +.. rst-class:: classref-method + +:ref:`Vector2` **max**\ (\ with\: :ref:`Vector2`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2(maxf(x, with.x), maxf(y, with.y))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_max_axis_index: .. rst-class:: classref-method @@ -754,6 +790,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector2_method_maxf: + +.. rst-class:: classref-method + +:ref:`Vector2` **maxf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2(maxf(x, with), maxf(y, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector2_method_min: + +.. rst-class:: classref-method + +:ref:`Vector2` **min**\ (\ with\: :ref:`Vector2`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2(minf(x, with.x), minf(y, with.y))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_min_axis_index: .. rst-class:: classref-method @@ -766,6 +826,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector2_method_minf: + +.. rst-class:: classref-method + +:ref:`Vector2` **minf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2(minf(x, with), minf(y, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_move_toward: .. rst-class:: classref-method @@ -928,6 +1000,18 @@ Returns a new vector resulting from sliding this vector along a line with normal Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector2_method_snappedf: + +.. rst-class:: classref-method + +:ref:`Vector2` **snappedf**\ (\ step\: :ref:`float`\ ) |const| + +Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 25613d0fb..2a82f4892 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -81,6 +81,8 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`clamp`\ (\ min\: :ref:`Vector2i`, max\: :ref:`Vector2i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`clampi`\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector2i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector2i`\ ) |const| | @@ -89,14 +91,24 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`max`\ (\ with\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`maxi`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`min`\ (\ with\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`mini`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`sign`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`snapped`\ (\ step\: :ref:`Vector2i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`snappedi`\ (\ step\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -356,6 +368,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector2i_method_clampi: + +.. rst-class:: classref-method + +:ref:`Vector2i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2i_method_distance_squared_to: .. rst-class:: classref-method @@ -408,6 +432,18 @@ This method runs faster than :ref:`length`, so pre ---- +.. _class_Vector2i_method_max: + +.. rst-class:: classref-method + +:ref:`Vector2i` **max**\ (\ with\: :ref:`Vector2i`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2i(maxi(x, with.x), maxi(y, with.y))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2i_method_max_axis_index: .. rst-class:: classref-method @@ -420,6 +456,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector2i_method_maxi: + +.. rst-class:: classref-method + +:ref:`Vector2i` **maxi**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector2i(maxi(x, with), maxi(y, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector2i_method_min: + +.. rst-class:: classref-method + +:ref:`Vector2i` **min**\ (\ with\: :ref:`Vector2i`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2i(mini(x, with.x), mini(y, with.y))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2i_method_min_axis_index: .. rst-class:: classref-method @@ -432,6 +492,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector2i_method_mini: + +.. rst-class:: classref-method + +:ref:`Vector2i` **mini**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2i(mini(x, with), mini(y, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2i_method_sign: .. rst-class:: classref-method @@ -452,6 +524,18 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector2i_method_snappedi: + +.. rst-class:: classref-method + +:ref:`Vector2i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| + +Returns a new vector with each component snapped to the closest multiple of ``step``. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 70a41ac6f..f6672415b 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -99,6 +99,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`clamp`\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`cross`\ (\ with\: :ref:`Vector3`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | @@ -133,10 +135,18 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`max`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`min`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`move_toward`\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`normalized`\ (\ ) |const| | @@ -153,7 +163,7 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project`\ (\ b\: :ref:`Vector3`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`reflect`\ (\ direction\: :ref:`Vector3`\ ) |const| | + | :ref:`Vector3` | :ref:`reflect`\ (\ n\: :ref:`Vector3`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -169,6 +179,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`snapped`\ (\ step\: :ref:`Vector3`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -556,6 +568,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector3_method_clampf: + +.. rst-class:: classref-method + +:ref:`Vector3` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_cross: .. rst-class:: classref-method @@ -776,6 +800,18 @@ Returns the vector with a maximum length by limiting its length to ``length``. ---- +.. _class_Vector3_method_max: + +.. rst-class:: classref-method + +:ref:`Vector3` **max**\ (\ with\: :ref:`Vector3`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3(maxf(x, with.x), maxf(y, with.y), maxf(z, with.z))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_max_axis_index: .. rst-class:: classref-method @@ -788,6 +824,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector3_method_maxf: + +.. rst-class:: classref-method + +:ref:`Vector3` **maxf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3(maxf(x, with), maxf(y, with), maxf(z, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector3_method_min: + +.. rst-class:: classref-method + +:ref:`Vector3` **min**\ (\ with\: :ref:`Vector3`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3(minf(x, with.x), minf(y, with.y), minf(z, with.z))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_min_axis_index: .. rst-class:: classref-method @@ -800,6 +860,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector3_method_minf: + +.. rst-class:: classref-method + +:ref:`Vector3` **minf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3(minf(x, with), minf(y, with), minf(z, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_move_toward: .. rst-class:: classref-method @@ -908,11 +980,11 @@ Returns a new vector resulting from projecting this vector onto the given vector .. rst-class:: classref-method -:ref:`Vector3` **reflect**\ (\ direction\: :ref:`Vector3`\ ) |const| +:ref:`Vector3` **reflect**\ (\ n\: :ref:`Vector3`\ ) |const| -Returns the result of reflecting the vector from a plane defined by the given direction vector ``direction``. +Returns the result of reflecting the vector through a plane defined by the given normal vector ``n``. -\ **Note:** :ref:`reflect` differs from what other engines and frameworks call ``reflect()``. In other engines, ``reflect()`` takes a normal direction which is a direction perpendicular to the plane. In Godot, you specify a direction parallel to the plane. See also :ref:`bounce` which does what most engines call ``reflect()``. +\ **Note:** :ref:`reflect` differs from what other engines and frameworks call ``reflect()``. In other engines, ``reflect()`` returns the result of the vector reflected by the given plane. The reflection thus passes through the given normal. While in Godot the reflection passes through the plane and can be thought of as bouncing off the normal. See also :ref:`bounce` which does what most engines call ``reflect()``. .. rst-class:: classref-item-separator @@ -1002,6 +1074,18 @@ Returns a new vector resulting from sliding this vector along a plane with norma Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector3_method_snappedf: + +.. rst-class:: classref-method + +:ref:`Vector3` **snappedf**\ (\ step\: :ref:`float`\ ) |const| + +Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index af6fddd60..5c7174f0b 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -81,6 +81,8 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`clamp`\ (\ min\: :ref:`Vector3i`, max\: :ref:`Vector3i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`clampi`\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector3i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector3i`\ ) |const| | @@ -89,14 +91,24 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`max`\ (\ with\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`maxi`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`min`\ (\ with\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`mini`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`sign`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`snapped`\ (\ step\: :ref:`Vector3i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`snappedi`\ (\ step\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -380,6 +392,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector3i_method_clampi: + +.. rst-class:: classref-method + +:ref:`Vector3i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3i_method_distance_squared_to: .. rst-class:: classref-method @@ -432,6 +456,18 @@ This method runs faster than :ref:`length`, so pre ---- +.. _class_Vector3i_method_max: + +.. rst-class:: classref-method + +:ref:`Vector3i` **max**\ (\ with\: :ref:`Vector3i`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3i_method_max_axis_index: .. rst-class:: classref-method @@ -444,6 +480,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector3i_method_maxi: + +.. rst-class:: classref-method + +:ref:`Vector3i` **maxi**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector3i(maxi(x, with), maxi(y, with), maxi(z, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector3i_method_min: + +.. rst-class:: classref-method + +:ref:`Vector3i` **min**\ (\ with\: :ref:`Vector3i`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3i(mini(x, with.x), mini(y, with.y), mini(z, with.z))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3i_method_min_axis_index: .. rst-class:: classref-method @@ -456,6 +516,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector3i_method_mini: + +.. rst-class:: classref-method + +:ref:`Vector3i` **mini**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3i(mini(x, with), mini(y, with), mini(z, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3i_method_sign: .. rst-class:: classref-method @@ -476,6 +548,18 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector3i_method_snappedi: + +.. rst-class:: classref-method + +:ref:`Vector3i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| + +Returns a new vector with each component snapped to the closest multiple of ``step``. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index 041bf4fa2..5e6dea7ec 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -76,6 +76,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`clamp`\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | @@ -106,10 +108,18 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`lerp`\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`max`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`min`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`normalized`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | @@ -122,6 +132,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`snapped`\ (\ step\: :ref:`Vector4`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -379,6 +391,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector4_method_clampf: + +.. rst-class:: classref-method + +:ref:`Vector4` **clampf**\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4_method_cubic_interpolate: .. rst-class:: classref-method @@ -567,6 +591,18 @@ Returns the result of the linear interpolation between this vector and ``to`` by ---- +.. _class_Vector4_method_max: + +.. rst-class:: classref-method + +:ref:`Vector4` **max**\ (\ with\: :ref:`Vector4`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with.x), maxf(y, with.y), maxf(z, with.z), maxf(w, with.w))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4_method_max_axis_index: .. rst-class:: classref-method @@ -579,6 +615,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector4_method_maxf: + +.. rst-class:: classref-method + +:ref:`Vector4` **maxf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with), maxf(y, with), maxf(z, with), maxf(w, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector4_method_min: + +.. rst-class:: classref-method + +:ref:`Vector4` **min**\ (\ with\: :ref:`Vector4`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with.x), minf(y, with.y), minf(z, with.z), minf(w, with.w))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4_method_min_axis_index: .. rst-class:: classref-method @@ -591,6 +651,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector4_method_minf: + +.. rst-class:: classref-method + +:ref:`Vector4` **minf**\ (\ with\: :ref:`float`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with), minf(y, with), minf(z, with), minf(w, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4_method_normalized: .. rst-class:: classref-method @@ -661,6 +733,18 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector4_method_snappedf: + +.. rst-class:: classref-method + +:ref:`Vector4` **snappedf**\ (\ step\: :ref:`float`\ ) |const| + +Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 91b138f11..d3b9bb388 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -72,6 +72,8 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4i` | :ref:`clamp`\ (\ min\: :ref:`Vector4i`, max\: :ref:`Vector4i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`clampi`\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector4i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector4i`\ ) |const| | @@ -80,14 +82,24 @@ Methods +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`max`\ (\ with\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`maxi`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`min`\ (\ with\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`mini`\ (\ with\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4i` | :ref:`sign`\ (\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4i` | :ref:`snapped`\ (\ step\: :ref:`Vector4i`\ ) |const| | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`snappedi`\ (\ step\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -343,6 +355,18 @@ Returns a new vector with all components clamped between the components of ``min ---- +.. _class_Vector4i_method_clampi: + +.. rst-class:: classref-method + +:ref:`Vector4i` **clampi**\ (\ min\: :ref:`int`, max\: :ref:`int`\ ) |const| + +Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4i_method_distance_squared_to: .. rst-class:: classref-method @@ -395,6 +419,18 @@ This method runs faster than :ref:`length`, so pre ---- +.. _class_Vector4i_method_max: + +.. rst-class:: classref-method + +:ref:`Vector4i` **max**\ (\ with\: :ref:`Vector4i`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z), maxi(w, with.w))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4i_method_max_axis_index: .. rst-class:: classref-method @@ -407,6 +443,30 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector4i_method_maxi: + +.. rst-class:: classref-method + +:ref:`Vector4i` **maxi**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4i(maxi(x, with), maxi(y, with), maxi(z, with), maxi(w, with))``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector4i_method_min: + +.. rst-class:: classref-method + +:ref:`Vector4i` **min**\ (\ with\: :ref:`Vector4i`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4i(mini(x, with.x), mini(y, with.y), mini(z, with.z), mini(w, with.w))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4i_method_min_axis_index: .. rst-class:: classref-method @@ -419,6 +479,18 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all ---- +.. _class_Vector4i_method_mini: + +.. rst-class:: classref-method + +:ref:`Vector4i` **mini**\ (\ with\: :ref:`int`\ ) |const| + +Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4i(mini(x, with), mini(y, with), mini(z, with), mini(w, with))``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4i_method_sign: .. rst-class:: classref-method @@ -439,6 +511,18 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector4i_method_snappedi: + +.. rst-class:: classref-method + +:ref:`Vector4i` **snappedi**\ (\ step\: :ref:`int`\ ) |const| + +Returns a new vector with each component snapped to the closest multiple of ``step``. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_xrserver.rst b/classes/class_xrserver.rst index daa35c33a..938e456db 100644 --- a/classes/class_xrserver.rst +++ b/classes/class_xrserver.rst @@ -59,7 +59,7 @@ Methods +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`center_on_hmd`\ (\ rotation_mode\: :ref:`RotationMode`, keep_height\: :ref:`bool`\ ) | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`clear_reference_frame`\ (\ ) |const| | + | |void| | :ref:`clear_reference_frame`\ (\ ) | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRInterface` | :ref:`find_interface`\ (\ name\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -393,7 +393,7 @@ You should call this method after a few seconds have passed. For example, when t .. rst-class:: classref-method -:ref:`Transform3D` **clear_reference_frame**\ (\ ) |const| +|void| **clear_reference_frame**\ (\ ) Clears the reference frame that was set by previous calls to :ref:`center_on_hmd`. diff --git a/classes/index.rst b/classes/index.rst index 6bfb3129b..e20368ca4 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -1052,6 +1052,7 @@ Variant types class_packedstringarray class_packedvector2array class_packedvector3array + class_packedvector4array class_plane class_projection class_quaternion