From d45f83bf92d731fe1ec13957d1baef5e6228e60d Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Mon, 15 Dec 2025 22:19:00 +0000 Subject: [PATCH] classref: Sync with current master branch (4b6c88d) --- classes/class_@gdscript.rst | 3 +- classes/class_@globalscope.rst | 6 +- classes/class_animationnodeoneshot.rst | 19 + classes/class_array.rst | 4 +- classes/class_audioserver.rst | 70 ++ classes/class_audiostreammp3.rst | 2 +- classes/class_audiostreamrandomizer.rst | 4 +- classes/class_basematerial3d.rst | 20 +- classes/class_bonetwistdisperser3d.rst | 581 +++++++++++++++++ classes/class_button.rst | 2 +- classes/class_canvasitem.rst | 4 +- classes/class_color.rst | 10 +- classes/class_confirmationdialog.rst | 2 +- classes/class_control.rst | 10 +- classes/class_converttransformmodifier3d.rst | 2 + classes/class_dictionary.rst | 4 +- classes/class_displayserver.rst | 66 +- classes/class_dpitexture.rst | 6 +- classes/class_editordock.rst | 121 +++- classes/class_editorexportplatform.rst | 8 +- classes/class_editorexportplatformandroid.rst | 6 +- .../class_editorexportplatformextension.rst | 4 +- classes/class_editorexportplatformios.rst | 2 + .../class_editorexportplatformlinuxbsd.rst | 2 + classes/class_editorexportplatformmacos.rst | 2 + .../class_editorexportplatformvisionos.rst | 2 + classes/class_editorexportplatformweb.rst | 4 +- classes/class_editorexportplatformwindows.rst | 2 + classes/class_editorexportpreset.rst | 104 +-- classes/class_editorfeatureprofile.rst | 20 +- classes/class_editorfiledialog.rst | 613 +----------------- classes/class_editorinterface.rst | 32 + classes/class_editorplugin.rst | 4 +- .../class_editorresourcepreviewgenerator.rst | 14 + classes/class_editorsettings.rst | 38 +- classes/class_editortoaster.rst | 2 +- classes/class_environment.rst | 54 +- classes/class_fileaccess.rst | 148 ++++- classes/class_filedialog.rst | 22 +- classes/class_foldablecontainer.rst | 2 +- classes/class_font.rst | 4 +- classes/class_geometryinstance3d.rst | 2 +- classes/class_gltfnode.rst | 2 +- classes/class_gltfstate.rst | 84 +-- classes/class_graphedit.rst | 8 +- classes/class_graphelement.rst | 19 + classes/class_image.rst | 4 +- classes/class_importermesh.rst | 14 + classes/class_itemlist.rst | 188 ++++-- classes/class_jsonrpc.rst | 4 +- classes/class_label.rst | 2 +- classes/class_label3d.rst | 2 +- classes/class_lineedit.rst | 76 ++- classes/class_linkbutton.rst | 2 +- classes/class_menubar.rst | 8 +- classes/class_mutex.rst | 2 - classes/class_navigationpolygon.rst | 4 +- classes/class_node.rst | 4 +- classes/class_object.rst | 8 +- classes/class_openxrapiextension.rst | 14 + classes/class_openxrextensionwrapper.rst | 12 +- ...class_openxrinteractionprofilemetadata.rst | 46 +- classes/class_openxrinterface.rst | 12 +- classes/class_packedbytearray.rst | 6 +- classes/class_packedcolorarray.rst | 98 +-- classes/class_packedfloat32array.rst | 98 +-- classes/class_packedfloat64array.rst | 98 +-- classes/class_packedint32array.rst | 98 +-- classes/class_packedint64array.rst | 98 +-- classes/class_packedstringarray.rst | 100 +-- classes/class_packedvector2array.rst | 98 +-- classes/class_packedvector3array.rst | 98 +-- classes/class_packedvector4array.rst | 98 +-- classes/class_particleprocessmaterial.rst | 2 +- classes/class_path3d.rst | 4 +- classes/class_performance.rst | 6 +- classes/class_popupmenu.rst | 6 +- classes/class_portablecompressedtexture2d.rst | 14 +- classes/class_projectsettings.rst | 96 ++- classes/class_range.rst | 2 +- classes/class_raycast2d.rst | 2 +- classes/class_renderingserver.rst | 24 +- classes/class_resource.rst | 4 +- classes/class_resourceimporterdynamicfont.rst | 2 +- classes/class_resourceimportermp3.rst | 2 +- classes/class_resourceuid.rst | 2 +- classes/class_richtextlabel.rst | 8 +- classes/class_rigidbody2d.rst | 6 +- classes/class_rigidbody3d.rst | 6 +- classes/class_script.rst | 2 +- classes/class_scrollcontainer.rst | 170 ++++- classes/class_skeleton3d.rst | 6 +- classes/class_skeletonmodifier3d.rst | 6 +- classes/class_splitcontainer.rst | 129 ++-- classes/class_springarm3d.rst | 2 +- classes/class_sprite2d.rst | 4 +- classes/class_streampeer.rst | 4 +- classes/class_string.rst | 2 +- classes/class_stringname.rst | 2 +- classes/class_tabbar.rst | 16 +- classes/class_tabcontainer.rst | 2 +- classes/class_textedit.rst | 2 +- classes/class_textmesh.rst | 4 +- classes/class_textserver.rst | 20 +- classes/class_textserverextension.rst | 16 +- classes/class_thread.rst | 4 +- classes/class_timer.rst | 2 +- classes/class_tree.rst | 162 ++++- classes/class_treeitem.rst | 2 +- classes/class_vector2i.rst | 2 +- classes/class_vector3i.rst | 2 +- classes/class_vector4i.rst | 2 +- classes/class_viewport.rst | 12 +- classes/class_voxelgi.rst | 4 +- classes/class_webrtcpeerconnection.rst | 19 +- classes/class_websocketpeer.rst | 10 +- classes/class_window.rst | 2 +- classes/class_xrinterfaceextension.rst | 2 +- classes/index.rst | 1 + 119 files changed, 2593 insertions(+), 1638 deletions(-) create mode 100644 classes/class_bonetwistdisperser3d.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index cae078bf5..844fd09e3 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -631,7 +631,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_GROUP` +**@export_multiline**\ (\ hint\: :ref:`String` = "", ...\ ) |vararg| :ref:`🔗` Export a :ref:`String`, :ref:`Array`\ \[:ref:`String`\ \], :ref:`PackedStringArray`, :ref:`Dictionary` or :ref:`Array`\ \[:ref:`Dictionary`\ \] property with a large :ref:`TextEdit` widget instead of a :ref:`LineEdit`. This adds support for multiline content and makes it easier to edit large amount of text stored in the property. @@ -641,6 +641,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_MULTILINE_TEXT`-derive Hints that a :ref:`String` property is text with line breaks. Editing it will show a text input field where line breaks can be typed. +The hint string can be set to ``"monospace"`` to force the input field to use a monospaced font. + +If the hint string ``"no_wrap"`` is set, the input field will not wrap lines at boundaries, instead resorting to making the area scrollable. + .. _class_@GlobalScope_constant_PROPERTY_HINT_EXPRESSION: .. rst-class:: classref-enumeration-constant @@ -7446,7 +7450,7 @@ Returns the internal type of the given ``variable``, using the :ref:`Variant.Typ var json = JSON.new() json.parse('["a", "b", "c"]') var result = json.get_data() - if result is Array: + if typeof(result) == TYPE_ARRAY: print(result[0]) # Prints "a" else: print("Unexpected result!") diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 97b8e1ce9..c3471d27b 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -89,6 +89,8 @@ Properties .. table:: :widths: auto + +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`abort_on_reset` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`autorestart` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ @@ -191,6 +193,23 @@ Blends two animations additively. See also :ref:`AnimationNodeAdd2` **abort_on_reset** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_abort_on_reset**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_aborted_on_reset**\ (\ ) + +If ``true``, the sub-animation will abort if resumed with a reset after a prior interruption. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationNodeOneShot_property_autorestart: .. rst-class:: classref-property diff --git a/classes/class_array.rst b/classes/class_array.rst index a78810195..b1f8c6a8e 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -685,7 +685,7 @@ If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dict :ref:`Array` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| :ref:`🔗` -Duplicates this array, deeply, like :ref:`duplicate()`\ ``(true)``, with extra control over how subresources are handled. +Duplicates this array, deeply, like :ref:`duplicate()` when passing ``true``, with extra control over how subresources are handled. \ ``deep_subresources_mode`` must be one of the values from :ref:`DeepDuplicateMode`. By default, only internal resources will be duplicated (recursively). @@ -836,7 +836,7 @@ Returns the first element of the array. If the array is empty, fails and returns :ref:`Variant` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the element at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``null``. +Returns the element at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``null``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 45d8a6efc..a4573cd67 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -91,8 +91,14 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_driver_name`\ (\ ) |const| | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_buffer_length_frames`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_input_device_list`\ (\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_input_frames`\ (\ frames\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_frames_available`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_input_mix_rate`\ (\ ) |const| | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_mix_rate`\ (\ ) |const| | @@ -147,6 +153,8 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_enable_tagging_used_audio_streams`\ (\ enable\: :ref:`bool`\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_input_device_active`\ (\ active\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`swap_bus_effects`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, by_effect_idx\: :ref:`int`\ ) | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unlock`\ (\ ) | @@ -548,6 +556,20 @@ Returns the name of the current audio driver. The default usually depends on the ---- +.. _class_AudioServer_method_get_input_buffer_length_frames: + +.. rst-class:: classref-method + +:ref:`int` **get_input_buffer_length_frames**\ (\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns the absolute size of the microphone input buffer. This is set to a multiple of the audio latency and can be used to estimate the minimum rate at which the frames need to be fetched. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioServer_method_get_input_device_list: .. rst-class:: classref-method @@ -562,6 +584,38 @@ Returns the names of all audio input devices detected on the system. ---- +.. _class_AudioServer_method_get_input_frames: + +.. rst-class:: classref-method + +:ref:`PackedVector2Array` **get_input_frames**\ (\ frames\: :ref:`int`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns a :ref:`PackedVector2Array` containing exactly ``frames`` audio samples from the internal microphone buffer if available, otherwise returns an empty :ref:`PackedVector2Array`. + +The buffer is filled at the rate of :ref:`get_input_mix_rate()` frames per second when :ref:`set_input_device_active()` has successfully been set to ``true``. + +The samples are signed floating-point PCM values between ``-1`` and ``1``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AudioServer_method_get_input_frames_available: + +.. rst-class:: classref-method + +:ref:`int` **get_input_frames_available**\ (\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +Returns the number of frames available to read using :ref:`get_input_frames()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioServer_method_get_input_mix_rate: .. rst-class:: classref-method @@ -902,6 +956,22 @@ If set to ``true``, all instances of :ref:`AudioStreamPlayback` **set_input_device_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` + +**Experimental:** This method may be changed or removed in future versions. + +If ``active`` is ``true``, starts the microphone input stream specified by :ref:`input_device` or returns an error if it failed. + +If ``active`` is ``false``, stops the input stream if it is running. + +.. rst-class:: classref-item-separator + +---- + .. _class_AudioServer_method_swap_bus_effects: .. rst-class:: classref-method diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 699e061f5..b8ef4412b 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -3,7 +3,7 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/AudioStreamMP3.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/mp3/doc_classes/AudioStreamMP3.xml. .. _class_AudioStreamMP3: diff --git a/classes/class_audiostreamrandomizer.rst b/classes/class_audiostreamrandomizer.rst index 613c7ad5c..8e943cb52 100644 --- a/classes/class_audiostreamrandomizer.rst +++ b/classes/class_audiostreamrandomizer.rst @@ -141,7 +141,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next. - |void| **set_random_pitch**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_random_pitch**\ (\ ) -The largest possible frequency multiplier of the random pitch variation. A value of ``1.0`` means no variation. +The largest possible frequency multiplier of the random pitch variation. Pitch will be randomly chosen within a range of ``1.0 / random_pitch`` and ``random_pitch``. A value of ``1.0`` means no variation. A value of ``2.0`` means pitch will be randomized between double and half. \ **Note:** Setting this property also sets :ref:`random_pitch_semitones`. @@ -179,7 +179,7 @@ The largest possible distance, in semitones, of the random pitch variation. A va - |void| **set_random_volume_offset_db**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_random_volume_offset_db**\ (\ ) -The intensity of random volume variation. A value of 0 means no variation. +The intensity of random volume variation. Volume will be increased or decreased by a random value up to ``random_volume_offset_db``. A value of ``0.0`` means no variation. A value of ``3.0`` means volume will be randomized between ``-3.0 dB`` and ``+3.0 dB``. .. rst-class:: classref-item-separator diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 1a5f2b1c2..8fe68c281 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -1517,7 +1517,7 @@ enum **StencilFlags**: :ref:`🔗` :ref:`StencilFlags` **STENCIL_FLAG_READ** = ``1`` -The material will only be rendered where it passes a stencil comparison with existing stencil buffer values. See :ref:`StencilCompare`. +The material will only be rendered where it passes a stencil comparison with existing stencil buffer values. .. _class_BaseMaterial3D_constant_STENCIL_FLAG_WRITE: @@ -2157,7 +2157,7 @@ Determines when depth rendering takes place. See also :ref:`transparency`. +Determines which comparison operator is used when testing depth. \ **Note:** Changing :ref:`depth_test` to a non-default value only has a visible effect when used on a transparent material, or a material that has :ref:`depth_draw_mode` set to :ref:`DEPTH_DRAW_DISABLED`. @@ -3342,7 +3342,7 @@ The primary color of the stencil effect. **Experimental:** May be affected by future rendering pipeline changes. -The comparison operator to use for stencil masking operations. See :ref:`StencilCompare`. +The comparison operator to use for stencil masking operations. .. rst-class:: classref-item-separator @@ -3361,7 +3361,7 @@ The comparison operator to use for stencil masking operations. See :ref:`Stencil **Experimental:** May be affected by future rendering pipeline changes. -The flags dictating how the stencil operation behaves. See :ref:`StencilFlags`. +The flags dictating how the stencil operation behaves. .. rst-class:: classref-item-separator @@ -3380,7 +3380,7 @@ The flags dictating how the stencil operation behaves. See :ref:`StencilFlags`. +The stencil effect mode. .. rst-class:: classref-item-separator @@ -3940,7 +3940,7 @@ Method Descriptions :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| :ref:`🔗` -Returns ``true``, if the specified :ref:`Feature` is enabled. +Returns ``true`` if the specified ``feature`` is enabled. .. rst-class:: classref-item-separator @@ -3952,7 +3952,7 @@ Returns ``true``, if the specified :ref:`Feature` i :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| :ref:`🔗` -Returns ``true`` if the specified flag is enabled. +Returns ``true`` if the specified ``flag`` is enabled. .. rst-class:: classref-item-separator @@ -3964,7 +3964,7 @@ Returns ``true`` if the specified flag is enabled. :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| :ref:`🔗` -Returns the :ref:`Texture2D` associated with the specified :ref:`TextureParam`. +Returns the :ref:`Texture2D` associated with the specified texture ``param``. .. rst-class:: classref-item-separator @@ -3976,7 +3976,7 @@ Returns the :ref:`Texture2D` associated with the specified :ref |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) :ref:`🔗` -If ``true``, enables the specified :ref:`Feature`. Many features that are available in **BaseMaterial3D**\ s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to ``true``. +If ``enable`` is ``true``, enables the specified ``feature``. Many features that are available in **BaseMaterial3D** need to be enabled before use. This way, the cost for using the feature is only incurred when specified. Features can also be enabled by setting their corresponding property to ``true``. .. rst-class:: classref-item-separator @@ -3988,7 +3988,7 @@ If ``true``, enables the specified :ref:`Feature`. |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) :ref:`🔗` -If ``true``, enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to ``true``. +If ``enable`` is ``true``, enables the specified ``flag``. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting their corresponding property to ``true``. .. rst-class:: classref-item-separator diff --git a/classes/class_bonetwistdisperser3d.rst b/classes/class_bonetwistdisperser3d.rst new file mode 100644 index 000000000..7951d376b --- /dev/null +++ b/classes/class_bonetwistdisperser3d.rst @@ -0,0 +1,581 @@ +: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/BoneTwistDisperser3D.xml. + +.. _class_BoneTwistDisperser3D: + +BoneTwistDisperser3D +==================== + +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +A node that propagates and disperses the child bone's twist to the parent bones. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This **BoneTwistDisperser3D** allows for smooth twist interpolation between multiple bones by dispersing the end bone's twist to the parents. This only changes the twist without changing the global position of each joint. + +This is useful for smoothly twisting bones in combination with :ref:`CopyTransformModifier3D` and IK. + +\ **Note:** If an extracted twist is greater than 180 degrees, flipping occurs. This is similar to :ref:`ConvertTransformModifier3D`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+---------------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------+---------------------------------------------------------------------------------+----------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------+---------------------------------------------------------------------------------+----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_settings`\ (\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`DisperseMode` | :ref:`get_disperse_mode`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_bone`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joint_bone_name`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_twist_amount`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_twist_from`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_weight_position`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_twist_from_rest`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disperse_mode`\ (\ index\: :ref:`int`, disperse_mode\: :ref:`DisperseMode`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_twist_amount`\ (\ index\: :ref:`int`, joint\: :ref:`int`, twist_amount\: :ref:`float`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_twist_from`\ (\ index\: :ref:`int`, from\: :ref:`Quaternion`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_twist_from_rest`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_weight_position`\ (\ index\: :ref:`int`, weight_position\: :ref:`float`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_BoneTwistDisperser3D_DisperseMode: + +.. rst-class:: classref-enumeration + +enum **DisperseMode**: :ref:`🔗` + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_EVEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_EVEN** = ``0`` + +Assign amounts so that they monotonically increase from ``0.0`` to ``1.0``, ensuring all weights are equal. For example, with five joints, the amounts would be ``0.2``, ``0.4``, ``0.6``, ``0.8``, and ``1.0`` starting from the root bone. + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_WEIGHTED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_WEIGHTED** = ``1`` + +Assign amounts so that they monotonically increase from ``0.0`` to ``1.0``, based on the length of the bones between joint segments. See also :ref:`set_weight_position()`. + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_CUSTOM** = ``2`` + +You can assign arbitrary amounts to the joint list. See also :ref:`set_joint_twist_amount()`. + +When :ref:`is_end_bone_extended()` is ``false``, a child of the reference bone exists solely to determine the twist axis, so its custom amount has absolutely no effect at all. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_BoneTwistDisperser3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +The number of settings. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_BoneTwistDisperser3D_method_clear_settings: + +.. rst-class:: classref-method + +|void| **clear_settings**\ (\ ) :ref:`🔗` + +Clears all settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_damping_curve: + +.. rst-class:: classref-method + +:ref:`Curve` **get_damping_curve**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the damping curve when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_disperse_mode: + +.. rst-class:: classref-method + +:ref:`DisperseMode` **get_disperse_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns whether to use automatic amount assignment or to allow manual assignment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_end_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone_direction: + +.. rst-class:: classref-method + +:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the tail direction of the end bone of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_end_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_bone**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone index at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_joint_bone_name**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone name at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_count: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_count**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint count of the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_twist_amount: + +.. rst-class:: classref-method + +:ref:`float` **get_joint_twist_amount**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the twist amount at ``joint`` in the bone chain's joint list when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_reference_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_reference_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference bone to extract twist of the setting at ``index``. + +This bone is either the end of the chain or its parent, depending on :ref:`is_end_bone_extended()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_reference_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_reference_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference bone name to extract twist of the setting at ``index``. + +This bone is either the end of the chain or its parent, depending on :ref:`is_end_bone_extended()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_root_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_root_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_root_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_root_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_twist_from: + +.. rst-class:: classref-method + +:ref:`Quaternion` **get_twist_from**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when :ref:`is_twist_from_rest()` is ``false``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_weight_position: + +.. rst-class:: classref-method + +:ref:`float` **get_weight_position**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the position at which to divide the segment between joints for weight assignment when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_WEIGHTED`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_is_end_bone_extended: + +.. rst-class:: classref-method + +:ref:`bool` **is_end_bone_extended**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the end bone is extended to have a tail. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_is_twist_from_rest: + +.. rst-class:: classref-method + +:ref:`bool` **is_twist_from_rest**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if extracting the twist amount from the difference between the bone rest and the current bone pose. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_damping_curve: + +.. rst-class:: classref-method + +|void| **set_damping_curve**\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) :ref:`🔗` + +Sets the damping curve when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_disperse_mode: + +.. rst-class:: classref-method + +|void| **set_disperse_mode**\ (\ index\: :ref:`int`, disperse_mode\: :ref:`DisperseMode`\ ) :ref:`🔗` + +Sets whether to use automatic amount assignment or to allow manual assignment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone: + +.. rst-class:: classref-method + +|void| **set_end_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone_direction: + +.. rst-class:: classref-method + +|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` + +Sets the end bone tail direction of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone_name: + +.. rst-class:: classref-method + +|void| **set_end_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the end bone name of the bone chain. + +\ **Note:** The end bone must be a child of the root bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_extend_end_bone: + +.. rst-class:: classref-method + +|void| **set_extend_end_bone**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, the end bone is extended to have a tail. + +If ``enabled`` is ``false``, :ref:`get_reference_bone()` becomes a parent of the end bone and it uses the vector to the end bone as a twist axis. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_joint_twist_amount: + +.. rst-class:: classref-method + +|void| **set_joint_twist_amount**\ (\ index\: :ref:`int`, joint\: :ref:`int`, twist_amount\: :ref:`float`\ ) :ref:`🔗` + +Sets the twist amount at ``joint`` in the bone chain's joint list when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_root_bone: + +.. rst-class:: classref-method + +|void| **set_root_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_root_bone_name: + +.. rst-class:: classref-method + +|void| **set_root_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_twist_from: + +.. rst-class:: classref-method + +|void| **set_twist_from**\ (\ index\: :ref:`int`, from\: :ref:`Quaternion`\ ) :ref:`🔗` + +Sets the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when :ref:`is_twist_from_rest()` is ``false``. + +In other words, by calling :ref:`set_twist_from()` by :ref:`SkeletonModifier3D.modification_processed` of a specific :ref:`SkeletonModifier3D`, you can extract only the twists generated by modifiers processed after that but before this **BoneTwistDisperser3D**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_twist_from_rest: + +.. rst-class:: classref-method + +|void| **set_twist_from_rest**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, it extracts the twist amount from the difference between the bone rest and the current bone pose. + +If ``enabled`` is ``false``, it extracts the twist amount from the difference between :ref:`get_twist_from()` and the current bone pose. See also :ref:`set_twist_from()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_weight_position: + +.. rst-class:: classref-method + +|void| **set_weight_position**\ (\ index\: :ref:`int`, weight_position\: :ref:`float`\ ) :ref:`🔗` + +Sets the position at which to divide the segment between joints for weight assignment when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_WEIGHTED`. + +For example, when ``weight_position`` is ``0.5``, if two bone segments with a length of ``1.0`` exist between three joints, weights are assigned to each joint from root to end at ratios of ``0.5``, ``1.0``, and ``0.5``. Then amounts become ``0.25``, ``0.75``, and ``1.0`` respectively. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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_button.rst b/classes/class_button.rst index ac36fa9c3..f6ea811c0 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -337,7 +337,7 @@ Specifies if the icon should be aligned horizontally to the left, right, or cent - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 7fd814cfd..54ab384e0 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -1440,7 +1440,7 @@ Returns the mouse's position in this **CanvasItem** using the local coordinate s Returns the transform of this **CanvasItem** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. -Equals to :ref:`get_global_transform()` if the window is embedded (see :ref:`Viewport.gui_embed_subwindows`). +Equivalent to :ref:`get_global_transform_with_canvas()` if the window is embedded (see :ref:`Viewport.gui_embed_subwindows`). .. rst-class:: classref-item-separator @@ -1650,7 +1650,7 @@ If ``true``, the node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`\ ) :ref:`🔗` -If ``true``, the node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever global transform changes. +If ``true``, the node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever its global transform changes. \ **Note:** Many canvas items such as :ref:`Camera2D` or :ref:`Light2D` automatically enable this in order to function correctly. diff --git a/classes/class_color.rst b/classes/class_color.rst index 9ca631ed5..cc3260f2c 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -19,7 +19,7 @@ Description A color represented in RGBA format by a red (:ref:`r`), green (:ref:`g`), blue (:ref:`b`), and alpha (:ref:`a`) component. Each component is a 32-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors. -Colors can be created in a number of ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv()`, and by using a name from the set of standardized colors based on `X11 color names `__ with the addition of :ref:`TRANSPARENT`. GDScript also provides :ref:`@GDScript.Color8()`, which uses integers from ``0`` to ``255`` and doesn't support overbright colors. +Colors can be created in a number of ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv()`, and by using a name from the set of standardized colors based on `X11 color names `__ with the addition of :ref:`TRANSPARENT`. \ `Color constants cheatsheet `__\ @@ -1643,7 +1643,7 @@ Constructs a **Color** from RGB values, typically between 0.0 and 1.0. :ref:`a`__. This method requires the original color to use linear encoding. See also :ref:`srgb_to_linear()` which performs the opposite operation. -\ **Note:** The color's :ref:`a`\ lpha channel is not affected. The alpha channel is always stored with linear encoding, regardless of the encoding of the other color channels. +\ **Note:** The color's alpha channel (:ref:`a`) is not affected. The alpha channel is always stored with linear encoding, regardless of the color space of the other color channels. .. rst-class:: classref-item-separator @@ -2101,7 +2101,7 @@ Returns a copy of the color that is encoded using the `nonlinear sRGB transfer f Returns a copy of the color that uses linear encoding. This method requires the original color to be encoded using the `nonlinear sRGB transfer function `__. See also :ref:`linear_to_srgb()` which performs the opposite operation. -\ **Note:** The color's :ref:`a`\ lpha channel is not affected. The alpha channel is always stored with linear encoding, regardless of the encoding of the other color channels. +\ **Note:** The color's alpha channel (:ref:`a`) is not affected. The alpha channel is always stored with linear encoding, regardless of the color space of the other color channels. .. rst-class:: classref-item-separator diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index d05027caf..d0256b1c8 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -12,7 +12,7 @@ ConfirmationDialog **Inherits:** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`EditorCommandPalette`, :ref:`EditorFileDialog`, :ref:`FileDialog`, :ref:`ScriptCreateDialog` +**Inherited By:** :ref:`EditorCommandPalette`, :ref:`FileDialog`, :ref:`ScriptCreateDialog` A dialog used for confirmation of actions. diff --git a/classes/class_control.rst b/classes/class_control.rst index 075999823..aae6f2af3 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -37,7 +37,7 @@ Call :ref:`accept_event()` so no other node r Only one **Control** node can be in focus. Only the node in focus will receive events. To get the focus, call :ref:`grab_focus()`. **Control** nodes lose focus when another node grabs it, or if you hide the node in focus. Focus will not be represented visually if gained via mouse/touch input, only appearing with keyboard/gamepad input (for accessibility), or via :ref:`grab_focus()`. -Sets :ref:`mouse_filter` to :ref:`MOUSE_FILTER_IGNORE` to tell a **Control** node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. +Set :ref:`mouse_filter` to :ref:`MOUSE_FILTER_IGNORE` to tell a **Control** node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. \ :ref:`Theme` resources change the control's appearance. The :ref:`theme` of a **Control** node affects all of its direct and indirect children (as long as a chain of controls is uninterrupted). To override some of the theme items, call one of the ``add_theme_*_override`` methods, like :ref:`add_theme_font_override()`. You can also override theme items in the Inspector. @@ -3041,13 +3041,17 @@ Returns the position and size of the control in the coordinate system of the con Returns the position of this **Control** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. -Equals to :ref:`global_position` if the window is embedded (see :ref:`Viewport.gui_embed_subwindows`). +Equivalent to ``get_screen_transform().origin`` (see :ref:`CanvasItem.get_screen_transform()`). \ **Example:** Show a popup at the mouse position: :: - popup_menu.position = get_screen_position() + get_local_mouse_position() + popup_menu.position = get_screen_position() + get_screen_transform().basis_xform(get_local_mouse_position()) + + # The above code is equivalent to: + popup_menu.position = get_screen_transform() * get_local_mouse_position() + popup_menu.reset_size() popup_menu.popup() diff --git a/classes/class_converttransformmodifier3d.rst b/classes/class_converttransformmodifier3d.rst index f64416976..9e5afd90f 100644 --- a/classes/class_converttransformmodifier3d.rst +++ b/classes/class_converttransformmodifier3d.rst @@ -41,6 +41,8 @@ There are 4 ways to apply the transform, depending on the combination of :ref:`s \ **Note:** Relative option is available only in the case :ref:`BoneConstraint3D.get_reference_type()` is :ref:`BoneConstraint3D.REFERENCE_TYPE_BONE`. See also :ref:`ReferenceType`. +\ **Note:** If there is a rotation greater than ``180`` degrees with constrained axes, flipping may occur. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index dddc4273c..f9bd1b04a 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -445,7 +445,7 @@ If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays and dict :ref:`Dictionary` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`int` = 1\ ) |const| :ref:`🔗` -Duplicates this dictionary, deeply, like :ref:`duplicate()`\ ``(true)``, with extra control over how subresources are handled. +Duplicates this dictionary, deeply, like :ref:`duplicate()` when passing ``true``, with extra control over how subresources are handled. \ ``deep_subresources_mode`` must be one of the values from :ref:`DeepDuplicateMode`. By default, only internal resources will be duplicated (recursively). @@ -894,7 +894,7 @@ Returns ``true`` if the two dictionaries contain the same keys and values, inner :ref:`bool` **set**\ (\ key\: :ref:`Variant`, value\: :ref:`Variant`\ ) :ref:`🔗` -Sets the value of the element at the given ``key`` to the given ``value``. This is the same as using the ``[]`` operator (``dict[key] = value``). Returns ``true`` if the value is set successfully. Fails and returns ``false`` if the dictionary is read-only, or if ``key`` and ``value`` don't match the dictionary's types. +Sets the value of the element at the given ``key`` to the given ``value``. Returns ``true`` if the value is set successfully. Fails and returns ``false`` if the dictionary is read-only, or if ``key`` and ``value`` don't match the dictionary's types. This is the same as using the ``[]`` operator (``dict[key] = value``). .. rst-class:: classref-item-separator diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 3d4af3a3f..c1f651c36 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -36,7 +36,7 @@ Methods +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`accessibility_create_sub_element`\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`accessibility_create_sub_text_edit_elements`\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1\ ) | + | :ref:`RID` | :ref:`accessibility_create_sub_text_edit_elements`\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1, is_last_line\: :ref:`bool` = false\ ) | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`accessibility_element_get_meta`\ (\ id\: :ref:`RID`\ ) |const| | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -698,7 +698,9 @@ Display server supports querying the operating system's display scale factor. Th :ref:`Feature` **FEATURE_ICON** = ``13`` -Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11)** +Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11/Wayland)**\ + +\ **Note:** Use on Wayland requires the compositor to implement the `xdg_toplevel_icon_v1 `__ protocol, which not all compositors do. See `xdg_toplevel_icon_v1#compositor-support `__ for more information on individual compositor support. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON: @@ -1304,7 +1306,7 @@ Element is hidden for accessibility tools. :ref:`AccessibilityFlags` **FLAG_MULTISELECTABLE** = ``1`` -Element is support multiple item selection. +Element supports multiple item selection. .. _class_DisplayServer_constant_FLAG_REQUIRED: @@ -2312,7 +2314,7 @@ Window maximize button is disabled. :ref:`WindowFlags` **WINDOW_FLAG_MAX** = ``13`` -Max value of the :ref:`WindowFlags`. +Represents the size of the :ref:`WindowFlags` enum. .. rst-class:: classref-item-separator @@ -2400,7 +2402,7 @@ Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXT :ref:`WindowEvent` **WINDOW_EVENT_FORCE_CLOSE** = ``8`` -Sent when the window has been forcibly closed by the Display Server. The window shall immediately hide and clean any internal rendering references. +Sent when the window has been forcibly closed by the display server. The window will immediately hide and clean any internal rendering references. \ **Note:** This flag is implemented only on Linux (Wayland). @@ -2792,10 +2794,12 @@ Creates a new, empty accessibility sub-element resource. Sub-elements can be use .. rst-class:: classref-method -:ref:`RID` **accessibility_create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1\ ) :ref:`🔗` +:ref:`RID` **accessibility_create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1, is_last_line\: :ref:`bool` = false\ ) :ref:`🔗` Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()` method. +If ``is_last_line`` is ``true``, no trailing newline is appended to the text content. Set to ``true`` for the last line in multi-line text fields and for single-line text fields. + .. rst-class:: classref-item-separator ---- @@ -2806,7 +2810,7 @@ Creates a new, empty accessibility sub-element from the shaped text buffer. Sub- :ref:`Variant` **accessibility_element_get_meta**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` -Returns the metadata of the accessibility element. +Returns the metadata of the accessibility element ``id``. .. rst-class:: classref-item-separator @@ -2818,7 +2822,7 @@ Returns the metadata of the accessibility element. |void| **accessibility_element_set_meta**\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) :ref:`🔗` -Sets the metadata of the accessibility element. +Sets the metadata of the accessibility element ``id`` to ``meta``. .. rst-class:: classref-item-separator @@ -2830,7 +2834,7 @@ Sets the metadata of the accessibility element. |void| **accessibility_free_element**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` -Frees an object created by :ref:`accessibility_create_element()`, :ref:`accessibility_create_sub_element()`, or :ref:`accessibility_create_sub_text_edit_elements()`. +Frees the accessibility element ``id`` created by :ref:`accessibility_create_element()`, :ref:`accessibility_create_sub_element()`, or :ref:`accessibility_create_sub_text_edit_elements()`. .. rst-class:: classref-item-separator @@ -2870,7 +2874,7 @@ Returns ``1`` if a screen reader, Braille display or other assistive app is acti \ **Note:** This method is implemented on Linux, macOS, and Windows. -\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps and will not affect this value. To test your app with these tools, set :ref:`ProjectSettings.accessibility/general/accessibility_support` to ``1``. +\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps and will not affect this value. To test your project with these tools, set :ref:`ProjectSettings.accessibility/general/accessibility_support` to ``1``. .. rst-class:: classref-item-separator @@ -3950,6 +3954,28 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt \ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()` to get a list of saved bookmarks. +\ **Note:** On Android, this method uses the Android Storage Access Framework (SAF). + +The file picker returns a URI instead of a filesystem path. This URI can be passed directly to :ref:`FileAccess` to perform read/write operations. + +When using :ref:`FILE_DIALOG_MODE_OPEN_DIR`, it returns a tree URI that grants full access to the selected directory. File operations inside this directory can be performed by passing a path on the form ``treeUri#relative/path/to/file`` to :ref:`FileAccess`. + +To avoid opening the file picker again after each app restart, you can take persistable URI permission as follows: + + +.. tabs:: + + .. code-tab:: gdscript + + val uri = "content://com.android..." # URI of the selected file or folder. + val persist = true # Set to false to release the persistable permission. + var android_runtime = Engine.get_singleton("AndroidRuntime") + android_runtime.updatePersistableUriPermission(uri, persist) + + + +The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted. + .. rst-class:: classref-item-separator ---- @@ -4094,7 +4120,7 @@ The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux :ref:`int` **get_primary_screen**\ (\ ) |const| :ref:`🔗` -Returns index of the primary screen. +Returns the index of the primary screen. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``0``. @@ -5540,11 +5566,11 @@ Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientat :ref:`Color` **screen_get_pixel**\ (\ position\: :ref:`Vector2i`\ ) |const| :ref:`🔗` -Returns color of the display pixel at the ``position``. +Returns the color of the pixel at the given screen ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area. -\ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns :ref:`Color`. +\ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns ``Color(0, 0, 0, 1)``. -\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will only contain the desktop wallpaper, the current application's window, and other related UI elements. +\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a color from a screenshot that will not include other application windows or OS elements not related to the application. .. rst-class:: classref-item-separator @@ -5697,7 +5723,7 @@ Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation()`\ ) :ref:`🔗` -Sets the ``callable`` that should be called when hardware keyboard is connected/disconnected. ``callable`` should accept a single :ref:`bool` parameter indicating whether the keyboard is connected (true) or disconnected (false). +Sets the callback that should be called when a hardware keyboard is connected or disconnected. ``callable`` should accept a single :ref:`bool` argument indicating whether the keyboard has been connected (``true``) or disconnected (``false``). \ **Note:** This method is only implemented on Android. @@ -5739,7 +5765,7 @@ Sets the window icon (usually displayed in the top-left corner) in the operating |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` -Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments. +Sets the callback that should be called when the system's theme settings are changed. ``callable`` should accept zero arguments. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland). @@ -6073,9 +6099,9 @@ Unregisters an :ref:`Object` representing an additional output, th :ref:`int` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`🔗` -Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. +Returns the on-screen keyboard's height in pixels. Returns ``0`` if there is no keyboard or if it is currently hidden. -\ **Note:** On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode. +\ **Note:** On Android 7 and 8, the keyboard height may return ``0`` the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode. .. rst-class:: classref-item-separator @@ -6373,7 +6399,7 @@ Returns ``true`` if the given window can be maximized (the maximize button is en :ref:`bool` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗` -Returns ``true``, if double-click on a window title should maximize it. +Returns ``true`` if double-clicking on a window's title should maximize it. \ **Note:** This method is implemented only on macOS. @@ -6387,7 +6413,7 @@ Returns ``true``, if double-click on a window title should maximize it. :ref:`bool` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗` -Returns ``true``, if double-click on a window title should minimize it. +Returns ``true`` if double-clicking on a window's title should minimize it. \ **Note:** This method is implemented only on macOS. diff --git a/classes/class_dpitexture.rst b/classes/class_dpitexture.rst index 8c688ab79..7d96aaffa 100644 --- a/classes/class_dpitexture.rst +++ b/classes/class_dpitexture.rst @@ -132,7 +132,7 @@ Method Descriptions :ref:`DPITexture` **create_from_string**\ (\ source\: :ref:`String`, scale\: :ref:`float` = 1.0, saturation\: :ref:`float` = 1.0, color_map\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` -Creates a new **DPITexture** and initializes it by allocating and setting the SVG data from string. +Creates a new **DPITexture** and initializes it by allocating and setting the SVG data to ``source``. .. rst-class:: classref-item-separator @@ -156,7 +156,7 @@ Returns the :ref:`RID` of the texture rasterized to match the oversam :ref:`String` **get_source**\ (\ ) |const| :ref:`🔗` -Returns SVG source code. +Returns this SVG texture's source code. .. rst-class:: classref-item-separator @@ -180,7 +180,7 @@ Resizes the texture to the specified dimensions. |void| **set_source**\ (\ source\: :ref:`String`\ ) :ref:`🔗` -Sets SVG source code. +Sets this SVG texture's source code. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_editordock.rst b/classes/class_editordock.rst index 020cbf6d9..480a7b449 100644 --- a/classes/class_editordock.rst +++ b/classes/class_editordock.rst @@ -66,29 +66,31 @@ Properties .. table:: :widths: auto - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | |bitfield|\[:ref:`DockLayout`\] | :ref:`available_layouts` | ``5`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`DockSlot` | :ref:`default_slot` | ``-1`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`dock_icon` | | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`Shortcut` | :ref:`dock_shortcut` | | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global` | ``true`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`icon_name` | ``&""`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layout_key` | ``""`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String` | :ref:`title` | ``""`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`title_color` | ``Color(0, 0, 0, 0)`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`transient` | ``false`` | - +-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+ + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | |bitfield|\[:ref:`DockLayout`\] | :ref:`available_layouts` | ``5`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`closable` | ``false`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`DockSlot` | :ref:`default_slot` | ``-1`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`dock_icon` | | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`Shortcut` | :ref:`dock_shortcut` | | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`force_show_icon` | ``false`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`global` | ``true`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`StringName` | :ref:`icon_name` | ``&""`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`String` | :ref:`layout_key` | ``""`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`String` | :ref:`title` | ``""`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`title_color` | ``Color(0, 0, 0, 0)`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`transient` | ``false`` | + +-------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group @@ -107,6 +109,8 @@ Methods +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`close`\ (\ ) | +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_visible`\ (\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`open`\ (\ ) | +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,6 +120,23 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_EditorDock_signal_closed: + +.. rst-class:: classref-signal + +**closed**\ (\ ) :ref:`🔗` + +Emitted when the dock is closed with the Close button in the context popup, before it's removed from its parent. See :ref:`closable`. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ @@ -183,6 +204,23 @@ The available layouts for this dock, as a bitmask. By default, the dock allows v ---- +.. _class_EditorDock_property_closable: + +.. rst-class:: classref-property + +:ref:`bool` **closable** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_closable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_closable**\ (\ ) + +If ``true``, the dock can be closed with the Close button in the context popup. Docks with :ref:`global` enabled are always closable. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDock_property_default_slot: .. rst-class:: classref-property @@ -230,7 +268,24 @@ The icon for the dock, as a texture. If specified, it will override :ref:`icon_n - |void| **set_dock_shortcut**\ (\ value\: :ref:`Shortcut`\ ) - :ref:`Shortcut` **get_dock_shortcut**\ (\ ) -The shortcut used to open the dock. This property can only be set before this dock is added via :ref:`EditorPlugin.add_dock()`. +The shortcut used to open the dock. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorDock_property_force_show_icon: + +.. rst-class:: classref-property + +:ref:`bool` **force_show_icon** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_force_show_icon**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_force_show_icon**\ (\ ) + +If ``true``, the dock will always display an icon, regardless of :ref:`EditorSettings.interface/editor/dock_tab_style` or :ref:`EditorSettings.interface/editor/bottom_dock_tab_style`. .. rst-class:: classref-item-separator @@ -247,7 +302,7 @@ The shortcut used to open the dock. This property can only be set before this do - |void| **set_global**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_global**\ (\ ) -If ``true``, the dock appears in the **Editor > Editor Docks** menu and can be closed. Non-global docks can still be closed using :ref:`close()`. +If ``true``, the dock appears in the **Editor > Editor Docks** menu and can be closed. Non-global docks can still be closed using :ref:`close()` or when :ref:`closable` is ``true``. .. rst-class:: classref-item-separator @@ -377,7 +432,7 @@ Implement this method to handle the layout switching for this dock. ``layout`` i :: - _update_layout(layout): + func _update_layout(layout): box_container.vertical = (layout == DOCK_LAYOUT_VERTICAL) .. rst-class:: classref-item-separator @@ -396,6 +451,18 @@ Closes the dock, making its tab hidden. ---- +.. _class_EditorDock_method_make_visible: + +.. rst-class:: classref-method + +|void| **make_visible**\ (\ ) :ref:`🔗` + +Focuses the dock's tab (or window if it's floating). If the dock was closed, it will be opened. If it's a bottom dock, makes the bottom panel visible. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorDock_method_open: .. rst-class:: classref-method @@ -404,6 +471,8 @@ Closes the dock, making its tab hidden. Opens the dock. It will appear in the last used dock slot. If the dock has no default slot, it will be opened floating. +\ **Note:** This does not focus the dock. If you want to open and focus the dock, use :ref:`make_visible()`. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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_editorexportplatform.rst b/classes/class_editorexportplatform.rst index ed17727ed..8a22beb25 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -386,7 +386,7 @@ Returns additional files that should always be exported regardless of preset con :ref:`String` **get_message_category**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns message category, for the message with ``index``. +Returns the message category for the message with the given ``index``. .. rst-class:: classref-item-separator @@ -398,7 +398,7 @@ Returns message category, for the message with ``index``. :ref:`int` **get_message_count**\ (\ ) |const| :ref:`🔗` -Returns number of messages in the export log. +Returns the number of messages in the export log. .. rst-class:: classref-item-separator @@ -410,7 +410,7 @@ Returns number of messages in the export log. :ref:`String` **get_message_text**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns message text, for the message with ``index``. +Returns the text for the message with the given ``index``. .. rst-class:: classref-item-separator @@ -422,7 +422,7 @@ Returns message text, for the message with ``index``. :ref:`ExportMessageType` **get_message_type**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns message type, for the message with ``index``. +Returns the type for the message with the given ``index``. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index da89b7cf1..1d179430a 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -460,7 +460,7 @@ Property Descriptions :ref:`String` **apk_expansion/SALT** :ref:`🔗` -Array of random bytes that the licensing Policy uses to create an `Obfuscator `__. +Array of random bytes that the licensing policy uses to create an `Obfuscator `__. .. rst-class:: classref-item-separator @@ -2830,7 +2830,7 @@ Allows an application to write to the user dictionary. :ref:`Color` **screen/background_color** :ref:`🔗` -The background color used for the root window. Default is ``black``. +The background color used for the root window. By default it's :ref:`Color.BLACK`. .. rst-class:: classref-item-separator @@ -2918,6 +2918,8 @@ Indicates whether the application supports extra large screen form-factors. If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformextension.rst b/classes/class_editorexportplatformextension.rst index 48139108b..63b92f815 100644 --- a/classes/class_editorexportplatformextension.rst +++ b/classes/class_editorexportplatformextension.rst @@ -118,9 +118,9 @@ Method Descriptions :ref:`bool` **_can_export**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` -Returns ``true``, if specified ``preset`` is valid and can be exported. Use :ref:`set_config_error()` and :ref:`set_config_missing_templates()` to set error details. +Returns ``true`` if the specified ``preset`` is valid and can be exported. Use :ref:`set_config_error()` and :ref:`set_config_missing_templates()` to set error details. -Usual implementation can call :ref:`_has_valid_export_configuration()` and :ref:`_has_valid_project_configuration()` to determine if export is possible. +Usual implementations call :ref:`_has_valid_export_configuration()` and :ref:`_has_valid_project_configuration()` to determine if exporting is possible. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index f7f34ad5c..b01ce262f 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -3372,6 +3372,8 @@ The reasons your app use user defaults API. See `Describing use of required reas If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 067d001bc..b5fc201ba 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -142,6 +142,8 @@ If ``true``, a console wrapper is exported alongside the main executable, which If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index 66ea11781..dad714868 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -3244,6 +3244,8 @@ Indicates whether your app uses data for tracking. See `Privacy manifest files < If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformvisionos.rst b/classes/class_editorexportplatformvisionos.rst index 91c238ab7..828ca54f5 100644 --- a/classes/class_editorexportplatformvisionos.rst +++ b/classes/class_editorexportplatformvisionos.rst @@ -2678,6 +2678,8 @@ The reasons your app use user defaults API. See `Describing use of required reas If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index c71fc9bcc..676a9246b 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -355,9 +355,9 @@ The number of threads that emscripten will allocate at startup. A smaller value :ref:`int` **threads/godot_pool_size** :ref:`🔗` -Override for the default size of the :ref:`WorkerThreadPool`. This setting is used when :ref:`ProjectSettings.threading/worker_pool/max_threads` size is set to -1 (which it is by default). This size must be smaller than :ref:`threads/emscripten_pool_size` otherwise deadlocks may occur. +Override for the default size of the :ref:`WorkerThreadPool`. This setting is used when :ref:`ProjectSettings.threading/worker_pool/max_threads` size is set to ``-1`` (which it is by default). This size must be smaller than :ref:`threads/emscripten_pool_size` otherwise deadlocks may occur. -When using threads this size needs to be large enough to accommodate features that rely on having a dedicated thread like :ref:`ProjectSettings.physics/2d/run_on_separate_thread` or :ref:`ProjectSettings.rendering/driver/threads/thread_model`. In general, it is best to ensure that this is at least 4 and is at least 2 or 3 less than :ref:`threads/emscripten_pool_size`. +When using threads, this size needs to be large enough to accommodate features that rely on having a dedicated thread like :ref:`ProjectSettings.physics/2d/run_on_separate_thread` or :ref:`ProjectSettings.rendering/driver/threads/thread_model`. In general, it is best to ensure that this is at least ``4`` and is at least ``2`` or ``3`` less than :ref:`threads/emscripten_pool_size`. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index 2e88873fc..46d2b4cd6 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -477,6 +477,8 @@ If ``true``, a console wrapper executable is exported alongside the main executa If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportpreset.rst b/classes/class_editorexportpreset.rst index 2de3a8be9..dda856de4 100644 --- a/classes/class_editorexportpreset.rst +++ b/classes/class_editorexportpreset.rst @@ -29,57 +29,57 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`are_advanced_options_enabled`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_custom_features`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_customized_files`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_customized_files_count`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_encrypt_directory`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_encrypt_pck`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_encryption_ex_filter`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_encryption_in_filter`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_encryption_key`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_exclude_filter`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ExportFilter` | :ref:`get_export_filter`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_export_path`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileExportMode` | :ref:`get_file_export_mode`\ (\ path\: :ref:`String`, default\: :ref:`FileExportMode` = 0\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_files_to_export`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_include_filter`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_or_env`\ (\ name\: :ref:`StringName`, env_var\: :ref:`String`\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_patches`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_preset_name`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_project_setting`\ (\ name\: :ref:`StringName`\ ) | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_script_export_mode`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_version`\ (\ name\: :ref:`StringName`, windows_version\: :ref:`bool`\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ property\: :ref:`StringName`\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_export_file`\ (\ path\: :ref:`String`\ ) | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dedicated_server`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_runnable`\ (\ ) |const| | - +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`are_advanced_options_enabled`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_custom_features`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_customized_files`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_customized_files_count`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_encrypt_directory`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_encrypt_pck`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_encryption_ex_filter`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_encryption_in_filter`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_encryption_key`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_exclude_filter`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ExportFilter` | :ref:`get_export_filter`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_export_path`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileExportMode` | :ref:`get_file_export_mode`\ (\ path\: :ref:`String`, default\: :ref:`FileExportMode` = 0\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_files_to_export`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_include_filter`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_or_env`\ (\ name\: :ref:`StringName`, env_var\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_patches`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_preset_name`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_project_setting`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptExportMode` | :ref:`get_script_export_mode`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_version`\ (\ name\: :ref:`StringName`, windows_version\: :ref:`bool`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ property\: :ref:`StringName`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_export_file`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dedicated_server`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_runnable`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -501,7 +501,7 @@ Returns the value of the setting identified by ``name`` using export preset feat .. rst-class:: classref-method -:ref:`int` **get_script_export_mode**\ (\ ) |const| :ref:`🔗` +:ref:`ScriptExportMode` **get_script_export_mode**\ (\ ) |const| :ref:`🔗` Returns the export mode used by GDScript files. ``0`` for "Text", ``1`` for "Binary tokens", and ``2`` for "Compressed binary tokens (smaller files)". diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 5aa2921d7..82dd0fc34 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -108,6 +108,8 @@ Scene tree editing. If this feature is disabled, the Scene tree dock will still :ref:`Feature` **FEATURE_NODE_DOCK** = ``4`` +**Deprecated:** Replaced by the Signals and Groups docks. + The Node dock. If this feature is disabled, signals and groups won't be visible and modifiable from the editor. .. _class_EditorFeatureProfile_constant_FEATURE_FILESYSTEM_DOCK: @@ -142,11 +144,27 @@ The History dock. If this feature is disabled, the History dock won't be visible The Game tab, which allows embedding the game window and selecting nodes by clicking inside of it. If this feature is disabled, the Game tab won't display. +.. _class_EditorFeatureProfile_constant_FEATURE_SIGNALS_DOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_SIGNALS_DOCK** = ``9`` + +The Signals dock. If this feature is disabled, signals won't be visible and modifiable from the editor. + +.. _class_EditorFeatureProfile_constant_FEATURE_GROUPS_DOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_GROUPS_DOCK** = ``10`` + +The Groups dock. If this feature is disabled, groups won't be visible and modifiable from the editor. + .. _class_EditorFeatureProfile_constant_FEATURE_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Feature` **FEATURE_MAX** = ``9`` +:ref:`Feature` **FEATURE_MAX** = ``11`` Represents the size of the :ref:`Feature` enum. diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index f901525cc..9b138a6e2 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -10,7 +10,7 @@ EditorFileDialog ================ -**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`FileDialog` **<** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` A modified version of :ref:`FileDialog` used by the editor. @@ -19,9 +19,9 @@ A modified version of :ref:`FileDialog` used by the editor. Description ----------- -**EditorFileDialog** is an enhanced version of :ref:`FileDialog` available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list. +**EditorFileDialog** is a :ref:`FileDialog` tweaked to work in the editor. It automatically handles favorite and recent directory lists, and synchronizes some properties with their corresponding editor settings. -Unlike :ref:`FileDialog`, **EditorFileDialog** does not have a property for using native dialogs. Instead, native dialogs can be enabled globally via the :ref:`EditorSettings.interface/editor/use_native_file_dialogs` editor setting. They are also enabled automatically when running in sandbox (e.g. on macOS). +\ **EditorFileDialog** will automatically show a native dialog based on the :ref:`EditorSettings.interface/editor/use_native_file_dialogs` editor setting and ignores :ref:`FileDialog.use_native_dialog`. \ **Note:** **EditorFileDialog** is invisible by default. To make it visible, call one of the ``popup_*`` methods from :ref:`Window` on the node, such as :ref:`Window.popup_centered_clamped()`. @@ -33,31 +33,9 @@ Properties .. table:: :widths: auto - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`Access` | :ref:`access` | ``0`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_dir` | | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_file` | | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`current_path` | | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog`) | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`disable_overwrite_warning` | ``false`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`DisplayMode` | :ref:`display_mode` | ``0`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`FileMode` | :ref:`file_mode` | ``4`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`option_count` | ``0`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | - +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + +-------------------------+---------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`disable_overwrite_warning` | ``false`` | + +-------------------------+---------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -67,211 +45,9 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_filename_filter`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_filters`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_filename_filter`\ (\ ) |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`invalidate`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`popup_file_dialog`\ (\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_filename_filter`\ (\ filter\: :ref:`String`\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Signals -------- - -.. _class_EditorFileDialog_signal_dir_selected: - -.. rst-class:: classref-signal - -**dir_selected**\ (\ dir\: :ref:`String`\ ) :ref:`🔗` - -Emitted when a directory is selected. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_signal_file_selected: - -.. rst-class:: classref-signal - -**file_selected**\ (\ path\: :ref:`String`\ ) :ref:`🔗` - -Emitted when a file is selected. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_signal_filename_filter_changed: - -.. rst-class:: classref-signal - -**filename_filter_changed**\ (\ filter\: :ref:`String`\ ) :ref:`🔗` - -Emitted when the filter for file names changes. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_signal_files_selected: - -.. rst-class:: classref-signal - -**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) :ref:`🔗` - -Emitted when multiple files are selected. - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Enumerations ------------- - -.. _enum_EditorFileDialog_FileMode: - -.. rst-class:: classref-enumeration - -enum **FileMode**: :ref:`🔗` - -.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE: - -.. rst-class:: classref-enumeration-constant - -:ref:`FileMode` **FILE_MODE_OPEN_FILE** = ``0`` - -The **EditorFileDialog** can select only one file. Accepting the window will open the file. - -.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILES: - -.. rst-class:: classref-enumeration-constant - -:ref:`FileMode` **FILE_MODE_OPEN_FILES** = ``1`` - -The **EditorFileDialog** can select multiple files. Accepting the window will open all files. - -.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_DIR: - -.. rst-class:: classref-enumeration-constant - -:ref:`FileMode` **FILE_MODE_OPEN_DIR** = ``2`` - -The **EditorFileDialog** can select only one directory. Accepting the window will open the directory. - -.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_ANY: - -.. rst-class:: classref-enumeration-constant - -:ref:`FileMode` **FILE_MODE_OPEN_ANY** = ``3`` - -The **EditorFileDialog** can select a file or directory. Accepting the window will open it. - -.. _class_EditorFileDialog_constant_FILE_MODE_SAVE_FILE: - -.. rst-class:: classref-enumeration-constant - -:ref:`FileMode` **FILE_MODE_SAVE_FILE** = ``4`` - -The **EditorFileDialog** can select only one file. Accepting the window will save the file. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_EditorFileDialog_Access: - -.. rst-class:: classref-enumeration - -enum **Access**: :ref:`🔗` - -.. _class_EditorFileDialog_constant_ACCESS_RESOURCES: - -.. rst-class:: classref-enumeration-constant - -:ref:`Access` **ACCESS_RESOURCES** = ``0`` - -The **EditorFileDialog** can only view ``res://`` directory contents. - -.. _class_EditorFileDialog_constant_ACCESS_USERDATA: - -.. rst-class:: classref-enumeration-constant - -:ref:`Access` **ACCESS_USERDATA** = ``1`` - -The **EditorFileDialog** can only view ``user://`` directory contents. - -.. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM: - -.. rst-class:: classref-enumeration-constant - -:ref:`Access` **ACCESS_FILESYSTEM** = ``2`` - -The **EditorFileDialog** can view the entire local file system. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_EditorFileDialog_DisplayMode: - -.. rst-class:: classref-enumeration - -enum **DisplayMode**: :ref:`🔗` - -.. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: - -.. rst-class:: classref-enumeration-constant - -:ref:`DisplayMode` **DISPLAY_THUMBNAILS** = ``0`` - -The **EditorFileDialog** displays resources as thumbnails. - -.. _class_EditorFileDialog_constant_DISPLAY_LIST: - -.. rst-class:: classref-enumeration-constant - -:ref:`DisplayMode` **DISPLAY_LIST** = ``1`` - -The **EditorFileDialog** displays resources as a list of filenames. + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -282,74 +58,6 @@ The **EditorFileDialog** displays resources as a list of filenames. Property Descriptions --------------------- -.. _class_EditorFileDialog_property_access: - -.. rst-class:: classref-property - -:ref:`Access` **access** = ``0`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_access**\ (\ value\: :ref:`Access`\ ) -- :ref:`Access` **get_access**\ (\ ) - -The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_current_dir: - -.. rst-class:: classref-property - -:ref:`String` **current_dir** :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_current_dir**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_current_dir**\ (\ ) - -The currently occupied directory. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_current_file: - -.. rst-class:: classref-property - -:ref:`String` **current_file** :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_current_file**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_current_file**\ (\ ) - -The currently selected file. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_current_path: - -.. rst-class:: classref-property - -:ref:`String` **current_path** :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_current_path**\ (\ value\: :ref:`String`\ ) -- :ref:`String` **get_current_path**\ (\ ) - -The file system path in the address bar. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorFileDialog_property_disable_overwrite_warning: .. rst-class:: classref-property @@ -361,95 +69,10 @@ The file system path in the address bar. - |void| **set_disable_overwrite_warning**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_overwrite_warning_disabled**\ (\ ) +**Deprecated:** Use :ref:`FileDialog.overwrite_warning_enabled` instead. + If ``true``, the **EditorFileDialog** will not warn the user before overwriting files. -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_display_mode: - -.. rst-class:: classref-property - -:ref:`DisplayMode` **display_mode** = ``0`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode`\ ) -- :ref:`DisplayMode` **get_display_mode**\ (\ ) - -The view format in which the **EditorFileDialog** displays resources to the user. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_file_mode: - -.. rst-class:: classref-property - -:ref:`FileMode` **file_mode** = ``4`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) -- :ref:`FileMode` **get_file_mode**\ (\ ) - -The dialog's open or save mode, which affects the selection behavior. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_filters: - -.. rst-class:: classref-property - -:ref:`PackedStringArray` **filters** = ``PackedStringArray()`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) -- :ref:`PackedStringArray` **get_filters**\ (\ ) - -The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected. - -**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_EditorFileDialog_property_option_count: - -.. rst-class:: classref-property - -:ref:`int` **option_count** = ``0`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_option_count**\ (\ value\: :ref:`int`\ ) -- :ref:`int` **get_option_count**\ (\ ) - -The number of additional :ref:`OptionButton`\ s and :ref:`CheckBox`\ es in the dialog. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_property_show_hidden_files: - -.. rst-class:: classref-property - -:ref:`bool` **show_hidden_files** = ``false`` :ref:`🔗` - -.. rst-class:: classref-property-setget - -- |void| **set_show_hidden_files**\ (\ value\: :ref:`bool`\ ) -- :ref:`bool` **is_showing_hidden_files**\ (\ ) - -If ``true``, hidden files and directories will be visible in the **EditorFileDialog**. This property is synchronized with :ref:`EditorSettings.filesystem/file_dialog/show_hidden_files`. - .. rst-class:: classref-section-separator ---- @@ -459,36 +82,6 @@ If ``true``, hidden files and directories will be visible in the **EditorFileDia Method Descriptions ------------------- -.. _class_EditorFileDialog_method_add_filter: - -.. rst-class:: classref-method - -|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) :ref:`🔗` - -Adds a comma-separated file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked. - -A ``filter`` should be of the form ``"filename.extension"``, where filename and extension can be ``*`` to match any string. Filters starting with ``.`` (i.e. empty filenames) are not allowed. - -For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)". - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_add_option: - -.. rst-class:: classref-method - -|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) :ref:`🔗` - -Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. - -\ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked). - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorFileDialog_method_add_side_menu: .. rst-class:: classref-method @@ -499,190 +92,6 @@ Adds an additional :ref:`OptionButton` to the file dialog. I This method is kept for compatibility and does nothing. As an alternative, you can display another dialog after showing the file dialog. -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_clear_filename_filter: - -.. rst-class:: classref-method - -|void| **clear_filename_filter**\ (\ ) :ref:`🔗` - -Clear the filter for file names. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_clear_filters: - -.. rst-class:: classref-method - -|void| **clear_filters**\ (\ ) :ref:`🔗` - -Removes all filters except for "All Files (\*.\*)". - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_filename_filter: - -.. rst-class:: classref-method - -:ref:`String` **get_filename_filter**\ (\ ) |const| :ref:`🔗` - -Returns the value of the filter for file names. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_line_edit: - -.. rst-class:: classref-method - -:ref:`LineEdit` **get_line_edit**\ (\ ) :ref:`🔗` - -Returns the LineEdit for the selected file. - -\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_option_default: - -.. rst-class:: classref-method - -:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` - -Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_option_name: - -.. rst-class:: classref-method - -:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` - -Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_option_values: - -.. rst-class:: classref-method - -:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` - -Returns an array of values of the :ref:`OptionButton` with index ``option``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_selected_options: - -.. rst-class:: classref-method - -:ref:`Dictionary` **get_selected_options**\ (\ ) |const| :ref:`🔗` - -Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_get_vbox: - -.. rst-class:: classref-method - -:ref:`VBoxContainer` **get_vbox**\ (\ ) :ref:`🔗` - -Returns the :ref:`VBoxContainer` used to display the file system. - -\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_invalidate: - -.. rst-class:: classref-method - -|void| **invalidate**\ (\ ) :ref:`🔗` - -Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_popup_file_dialog: - -.. rst-class:: classref-method - -|void| **popup_file_dialog**\ (\ ) :ref:`🔗` - -Shows the **EditorFileDialog** at the default size and position for file dialogs in the editor, and selects the file name if there is a current file. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_set_filename_filter: - -.. rst-class:: classref-method - -|void| **set_filename_filter**\ (\ filter\: :ref:`String`\ ) :ref:`🔗` - -Sets the value of the filter for file names. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_set_option_default: - -.. rst-class:: classref-method - -|void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) :ref:`🔗` - -Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_set_option_name: - -.. rst-class:: classref-method - -|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` - -Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_EditorFileDialog_method_set_option_values: - -.. rst-class:: classref-method - -|void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) :ref:`🔗` - -Sets the option values of the :ref:`OptionButton` with index ``option``. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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_editorinterface.rst b/classes/class_editorinterface.rst index fdd223534..143d8bb8f 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -134,6 +134,8 @@ Methods +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_3d_snap_enabled`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_object_edited`\ (\ object\: :ref:`Object`\ ) |const| | + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing_scene`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_plugin_enabled`\ (\ plugin\: :ref:`String`\ ) |const| | @@ -184,6 +186,8 @@ Methods +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_main_screen_editor`\ (\ name\: :ref:`String`\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_object_edited`\ (\ object\: :ref:`Object`, edited\: :ref:`bool`\ ) | + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_plugin_enabled`\ (\ plugin\: :ref:`String`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`stop_playing_scene`\ (\ ) | @@ -709,6 +713,18 @@ Returns ``true`` if the 3D editor currently has snapping mode enabled, and ``fal ---- +.. _class_EditorInterface_method_is_object_edited: + +.. rst-class:: classref-method + +:ref:`bool` **is_object_edited**\ (\ object\: :ref:`Object`\ ) |const| :ref:`🔗` + +Returns ``true`` if the object has been marked as edited through :ref:`set_object_edited()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_is_playing_scene: .. rst-class:: classref-method @@ -1061,6 +1077,22 @@ Sets the editor's current main screen to the one specified in ``name``. ``name`` ---- +.. _class_EditorInterface_method_set_object_edited: + +.. rst-class:: classref-method + +|void| **set_object_edited**\ (\ object\: :ref:`Object`, edited\: :ref:`bool`\ ) :ref:`🔗` + +If ``edited`` is ``true``, the object is marked as edited. + +\ **Note:** This is primarily used by the editor for :ref:`Resource` based objects to track their modified state. For example, any changes to an open scene, a resource in the inspector, or an edited script will cause this method to be called with ``true``. Saving the scene, script, or resource resets the edited state by calling this method with ``false``. + +\ **Note:** Each call to this method increments the object's edited version. This is used to track changes in the editor and to trigger when thumbnails should be regenerated for resources. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_set_plugin_enabled: .. rst-class:: classref-method diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 816e7b22d..6426493de 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -1157,7 +1157,9 @@ Adds a plugin to the context menu. ``slot`` is the context menu where the plugin Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to a button that is outside the scene tree. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel()` and free it with :ref:`Node.queue_free()`. -Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use :kbd:`Alt` modifier. +\ ``shortcut`` is a shortcut that, when activated, will toggle the bottom panel's visibility. The shortcut object is only set when this control is added to the bottom panel. + +\ **Note** See the default editor bottom panel shortcuts in the Editor Settings for inspiration. By convention, they all use :kbd:`Alt` modifier. .. rst-class:: classref-item-separator diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 991002db1..82442ab80 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -40,6 +40,8 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_handles`\ (\ type\: :ref:`String`\ ) |virtual| |required| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_draw_and_wait`\ (\ viewport\: :ref:`RID`\ ) |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -122,6 +124,18 @@ By default, it returns ``false``. Returns ``true`` if your generator supports the resource of type ``type``. +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorResourcePreviewGenerator_method_request_draw_and_wait: + +.. rst-class:: classref-method + +|void| **request_draw_and_wait**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` + +Call from within :ref:`_generate()` to request the rendering server draw to the ``viewport``. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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_editorsettings.rst b/classes/class_editorsettings.rst index 96b526c04..3be229ea0 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -455,6 +455,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/bottom_dock_tab_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`interface/editor/code_font` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/code_font_contextual_ligatures` | @@ -3526,7 +3528,7 @@ Editor accessibility support mode: - **Disabled** (``2``): Accessibility support is fully disabled. -\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD) do not count as assistive apps. To test your project with these tools, use **Always Active**. +\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test the editor with these tools, use **Always Active**. .. rst-class:: classref-item-separator @@ -3538,13 +3540,15 @@ Editor accessibility support mode: :ref:`int` **interface/editor/accept_dialog_cancel_ok_buttons** :ref:`🔗` -How to position the Cancel and OK buttons in the editor's :ref:`AcceptDialog`\ s. Different platforms have different standard behaviors for this, which can be overridden using this setting. This is useful if you use Godot both on Windows and macOS/Linux and your Godot muscle memory is stronger than your OS specific one. +How to position the Cancel and OK buttons in the editor's :ref:`AcceptDialog` windows. Different platforms have different conventions for this, which can be overridden through this setting to avoid accidental clicks when using Godot on multiple platforms. -- **Auto** follows the platform convention: OK first on Windows, KDE, and LXQt, Cancel first on macOS and other Linux desktop environments. +- **Auto** follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments. -- **Cancel First** forces the ordering Cancel/OK. +- **Cancel First** forces the Cancel/OK ordering. -- **OK First** forces the ordering OK/Cancel. +- **OK First** forces the OK/Cancel ordering. + +To check if these buttons are swapped at runtime, use :ref:`DisplayServer.get_swap_cancel_ok()`. .. rst-class:: classref-item-separator @@ -3562,6 +3566,18 @@ If ``true``, automatically opens screenshots with the default program associated ---- +.. _class_EditorSettings_property_interface/editor/bottom_dock_tab_style: + +.. rst-class:: classref-property + +:ref:`int` **interface/editor/bottom_dock_tab_style** :ref:`🔗` + +Tab style of editor docks located at the bottom. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/code_font: .. rst-class:: classref-property @@ -3680,7 +3696,7 @@ If set to **Custom**, the scaling value in :ref:`interface/editor/custom_display :ref:`int` **interface/editor/dock_tab_style** :ref:`🔗` -Tab style of editor docks. +Tab style of editor docks, except bottom docks. .. rst-class:: classref-item-separator @@ -4752,7 +4768,7 @@ If ``true``, enable two finger pan and scale gestures on touchscreen devices. :ref:`bool` **interface/touchscreen/enable_touch_optimizations** :ref:`🔗` -If ``true``, increases the scrollbar touch area and enables a larger dragger for split containers to improve usability on touchscreen devices +If ``true``, increases the scrollbar touch area, enables a larger dragger for split containers, and increases PopupMenu vertical separation to improve usability on touchscreen devices. \ **Note:** Defaults to ``true`` on touchscreen devices. @@ -4816,7 +4832,7 @@ All update modes will ignore builds with different major versions (e.g. Godot 4 :ref:`int` **network/connection/network_mode** :ref:`🔗` -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. +Determines whether online features, such as the Asset Library or update checks, are enabled in the editor. If this is a privacy concern, disabling these online features prevents the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Library. Editor plugins and tool scripts are recommended to follow this setting. However, Godot can't prevent them from violating this rule. @@ -4882,7 +4898,7 @@ The port number to use to contact the HTTP and HTTPS proxy in the editor (for th :ref:`String` **network/tls/editor_tls_certificates** :ref:`🔗` -The TLS certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the `included Mozilla certificate bundle `__ will be used. +The TLS certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the `included Mozilla certificate bundle `__ will be used. .. rst-class:: classref-item-separator @@ -5578,7 +5594,7 @@ If ``true``, the caret will be moved when right-clicking somewhere in the script :ref:`bool` **text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method** :ref:`🔗` -If ``true``, opens the script editor when connecting a signal to an existing script method from the Node dock. +If ``true``, opens the script editor when connecting a signal to an existing script method from the Signals dock. .. rst-class:: classref-item-separator @@ -5696,7 +5712,7 @@ If ``true``, automatically adds :doc:`GDScript static typing <../tutorials/scrip - Creating a new script from a template; -- Connecting signals from the Node dock; +- Connecting signals from the Signals dock; - Creating variables prefixed with :ref:`@GDScript.@onready`, by dropping nodes from the Scene dock into the script editor while holding :kbd:`Ctrl`. diff --git a/classes/class_editortoaster.rst b/classes/class_editortoaster.rst index dab918737..b760d8fb6 100644 --- a/classes/class_editortoaster.rst +++ b/classes/class_editortoaster.rst @@ -19,7 +19,7 @@ Manages toast notifications within the editor. Description ----------- -This object manages the functionality and display of toast notifications within the editor, ensuring timely and informative alerts are presented to users. +This object manages the functionality and display of toast notifications within the editor, ensuring immediate and informative alerts are presented to the user. \ **Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorInterface.get_editor_toaster()`. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 0df748a8b..80c06ca6d 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -217,6 +217,10 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`ssr_max_steps` | ``64`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`tonemap_agx_contrast` | ``1.25`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`tonemap_agx_white` | ``16.29`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`tonemap_exposure` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`ToneMapper` | :ref:`tonemap_mode` | ``0`` | @@ -463,9 +467,7 @@ Uses a high-contrast film-like tonemapping curve and desaturates bright values f :ref:`ToneMapper` **TONE_MAPPER_AGX** = ``4`` -Uses a film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. - -\ **Note:** :ref:`tonemap_white` is fixed at a value of ``16.29``, which makes :ref:`TONE_MAPPER_AGX` unsuitable for use with the Mobile rendering method. +Uses an adjustable film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. .. rst-class:: classref-item-separator @@ -1159,7 +1161,7 @@ The higher threshold of the HDR glow. Areas brighter than this threshold will be - |void| **set_glow_hdr_bleed_scale**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_glow_hdr_bleed_scale**\ (\ ) -The bleed scale of the HDR glow. +Smooths the transition between values that are below and above :ref:`glow_hdr_threshold` by reducing the amount of glow generated by values that are close to :ref:`glow_hdr_threshold`. Values above ``glow_hdr_threshold + glow_hdr_scale`` will not have glow reduced in this way. .. rst-class:: classref-item-separator @@ -1193,7 +1195,7 @@ The lower threshold of the HDR glow. When using the Mobile rendering method (whi - |void| **set_glow_intensity**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_glow_intensity**\ (\ ) -The overall brightness multiplier of the glow effect. When using the Mobile rendering method (which only supports a lower dynamic range up to ``2.0``), this should be increased to ``1.5`` to compensate. +The overall brightness multiplier that is applied to the glow effect just before it is blended with the scene. When using the Mobile rendering method (which only supports a lower dynamic range up to ``2.0``), this should be increased to ``1.5`` to compensate. .. rst-class:: classref-item-separator @@ -1423,7 +1425,7 @@ If ``true``, glow levels will be normalized so that summed together their intens - |void| **set_glow_strength**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_glow_strength**\ (\ ) -The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the Mobile rendering method, this should be increased to compensate for the lower dynamic range. +The strength that is used when blurring across the screen to generate the glow effect. This affects the distance and intensity of the blur. When using the Mobile rendering method, this should be increased to compensate for the lower dynamic range. \ **Note:** :ref:`glow_strength` has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. @@ -2048,6 +2050,42 @@ The maximum number of steps for screen-space reflections. Higher values are slow ---- +.. _class_Environment_property_tonemap_agx_contrast: + +.. rst-class:: classref-property + +:ref:`float` **tonemap_agx_contrast** = ``1.25`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tonemap_agx_contrast**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tonemap_agx_contrast**\ (\ ) + +Increasing :ref:`tonemap_agx_contrast` will make dark values darker and bright values brighter. Produces a higher quality result than :ref:`adjustment_contrast` without any additional performance cost, but is only available when using the :ref:`TONE_MAPPER_AGX` tonemapper. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Environment_property_tonemap_agx_white: + +.. rst-class:: classref-property + +:ref:`float` **tonemap_agx_white** = ``16.29`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tonemap_agx_white**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tonemap_agx_white**\ (\ ) + +The white reference value for tonemapping, which indicates where bright white is located in the scale of values provided to the tonemapper. For photorealistic lighting, it is recommended to set :ref:`tonemap_agx_white` to at least ``6.0``. Higher values result in less blown out highlights, but may make the scene appear lower contrast. :ref:`tonemap_agx_white` is the same as :ref:`tonemap_white`, but is only effective with the :ref:`TONE_MAPPER_AGX` tonemapper. See also :ref:`tonemap_exposure`. + +\ **Note:** When using the Mobile renderer with :ref:`Viewport.use_hdr_2d` disabled, :ref:`tonemap_agx_white` is ignored and a white value of ``2.0`` will always be used instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_Environment_property_tonemap_exposure: .. rst-class:: classref-property @@ -2095,9 +2133,9 @@ The tonemapping mode to use. Tonemapping is the process that "converts" HDR valu - |void| **set_tonemap_white**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_tonemap_white**\ (\ ) -The white reference value for tonemapping, which indicates where bright white is located in the scale of values provided to the tonemapper. For photorealistic lighting, recommended values are between ``6.0`` and ``8.0``. Higher values result in less blown out highlights, but may make the scene appear lower contrast. See also :ref:`tonemap_exposure`. +The white reference value for tonemapping, which indicates where bright white is located in the scale of values provided to the tonemapper. For photorealistic lighting, it is recommended to set :ref:`tonemap_white` to at least ``6.0``. Higher values result in less blown out highlights, but may make the scene appear lower contrast. :ref:`tonemap_agx_white` will be used instead when using the :ref:`TONE_MAPPER_AGX` tonemapper. See also :ref:`tonemap_exposure`. -\ **Note:** :ref:`tonemap_white` is ignored when using :ref:`TONE_MAPPER_LINEAR` or :ref:`TONE_MAPPER_AGX`. +\ **Note:** :ref:`tonemap_white` must be set to ``2.0`` or lower on the Mobile renderer to produce bright images. .. rst-class:: classref-item-separator diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index f8c6ec0a2..32a1439a3 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -126,6 +126,12 @@ Methods +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`get_error`\ (\ ) |const| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_extended_attribute`\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_extended_attribute_string`\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_extended_attributes_list`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`get_file_as_bytes`\ (\ path\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_as_string`\ (\ path\: :ref:`String`\ ) |static| | @@ -176,12 +182,18 @@ Methods +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FileAccess` | :ref:`open_encrypted_with_pass`\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, pass\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`remove_extended_attribute`\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`resize`\ (\ length\: :ref:`int`\ ) | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`seek`\ (\ position\: :ref:`int`\ ) | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`seek_end`\ (\ position\: :ref:`int` = 0\ ) | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_extended_attribute`\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`, data\: :ref:`PackedByteArray`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_extended_attribute_string`\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`, data\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_hidden_attribute`\ (\ file\: :ref:`String`, hidden\: :ref:`bool`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_read_only_attribute`\ (\ file\: :ref:`String`, ro\: :ref:`bool`\ ) |static| | @@ -684,6 +696,66 @@ Returns the last error that happened when trying to perform operations. Compare ---- +.. _class_FileAccess_method_get_extended_attribute: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **get_extended_attribute**\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| :ref:`🔗` + +Reads the file extended attribute with name ``attribute_name`` as a byte array. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileAccess_method_get_extended_attribute_string: + +.. rst-class:: classref-method + +:ref:`String` **get_extended_attribute_string**\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| :ref:`🔗` + +Reads the file extended attribute with name ``attribute_name`` as a UTF-8 encoded string. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileAccess_method_get_extended_attributes_list: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **get_extended_attributes_list**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` + +Returns a list of file extended attributes. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileAccess_method_get_file_as_bytes: .. rst-class:: classref-method @@ -742,7 +814,7 @@ Returns the next 16 bits from the file as a half-precision floating-point number :ref:`bool` **get_hidden_attribute**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` -Returns ``true``, if file ``hidden`` attribute is set. +Returns ``true`` if the **hidden** attribute is set on the file at the given path. \ **Note:** This method is implemented on iOS, BSD, macOS, and Windows. @@ -868,7 +940,7 @@ Returns the file cursor's position in bytes from the beginning of the file. This :ref:`bool` **get_read_only_attribute**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` -Returns ``true``, if file ``read only`` attribute is set. +Returns ``true`` if the **read only** attribute is set on the file at the given path. \ **Note:** This method is implemented on iOS, BSD, macOS, and Windows. @@ -908,7 +980,7 @@ Returns an SHA-256 :ref:`String` representing the file at the give :ref:`int` **get_size**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` -Returns file size in bytes, or ``-1`` on error. +Returns the size of the file at the given path, in bytes, or ``-1`` on error. .. rst-class:: classref-item-separator @@ -920,7 +992,7 @@ Returns file size in bytes, or ``-1`` on error. |bitfield|\[:ref:`UnixPermissionFlags`\] **get_unix_permissions**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` -Returns file UNIX permissions. +Returns the UNIX permissions of the file at the given path. \ **Note:** This method is implemented on iOS, Linux/BSD, and macOS. @@ -1016,6 +1088,26 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error()< ---- +.. _class_FileAccess_method_remove_extended_attribute: + +.. rst-class:: classref-method + +:ref:`Error` **remove_extended_attribute**\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`\ ) |static| :ref:`🔗` + +Removes file extended attribute with name ``attribute_name``. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileAccess_method_resize: .. rst-class:: classref-method @@ -1034,7 +1126,7 @@ Resizes the file to a specified length. The file must be open in a mode that per |void| **seek**\ (\ position\: :ref:`int`\ ) :ref:`🔗` -Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). This changes the value returned by :ref:`get_position()`. +Sets the file cursor to the specified position in bytes, from the beginning of the file. This changes the value returned by :ref:`get_position()`. .. rst-class:: classref-item-separator @@ -1046,9 +1138,49 @@ Changes the file reading/writing cursor to the specified position (in bytes from |void| **seek_end**\ (\ position\: :ref:`int` = 0\ ) :ref:`🔗` -Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). This changes the value returned by :ref:`get_position()`. +Sets the file cursor to the specified position in bytes, from the end of the file. This changes the value returned by :ref:`get_position()`. -\ **Note:** This is an offset, so you should use negative numbers or the file cursor will be at the end of the file. +\ **Note:** This is an offset, so you should use negative numbers otherwise the file cursor will be at the end of the file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileAccess_method_set_extended_attribute: + +.. rst-class:: classref-method + +:ref:`Error` **set_extended_attribute**\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`, data\: :ref:`PackedByteArray`\ ) |static| :ref:`🔗` + +Writes file extended attribute with name ``attribute_name`` as a byte array. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FileAccess_method_set_extended_attribute_string: + +.. rst-class:: classref-method + +:ref:`Error` **set_extended_attribute_string**\ (\ file\: :ref:`String`, attribute_name\: :ref:`String`, data\: :ref:`String`\ ) |static| :ref:`🔗` + +Writes file extended attribute with name ``attribute_name`` as a UTF-8 encoded string. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems. + +\ **Note:** On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included. + +\ **Note:** On Windows, alternate data streams are used to store extended attributes. .. rst-class:: classref-item-separator @@ -1223,7 +1355,7 @@ Stores the given array of bytes in the file. This advances the file cursor by th :ref:`bool` **store_csv_line**\ (\ values\: :ref:`PackedStringArray`, delim\: :ref:`String` = ","\ ) :ref:`🔗` -Store the given :ref:`PackedStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. +Stores the given :ref:`PackedStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. Returns ``true`` if the operation is successful. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 4aa123b72..35962ec5a 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -12,6 +12,8 @@ FileDialog **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`EditorFileDialog` + A dialog for selecting files or directories in the filesystem. .. rst-class:: classref-introduction-group @@ -122,6 +124,8 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_customization_flag_enabled`\ (\ flag\: :ref:`Customization`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_file_dialog`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_customization_flag_enabled`\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_favorite_list`\ (\ favorites\: :ref:`PackedStringArray`\ ) |static| | @@ -860,6 +864,8 @@ If ``true``, and if supported by the current :ref:`DisplayServer`. + .. rst-class:: classref-section-separator ---- @@ -1045,7 +1051,7 @@ Returns the vertical box container of the dialog, custom controls can be added t |void| **invalidate**\ (\ ) :ref:`🔗` -Invalidate and update the current dialog content list. +Invalidates and updates this dialog's content list. \ **Note:** This method does nothing on native file dialogs. @@ -1065,13 +1071,25 @@ Returns ``true`` if the provided ``flag`` is enabled. ---- +.. _class_FileDialog_method_popup_file_dialog: + +.. rst-class:: classref-method + +|void| **popup_file_dialog**\ (\ ) :ref:`🔗` + +Shows the **FileDialog** using the default size and position for file dialogs, and selects the file name if there is a current file. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileDialog_method_set_customization_flag_enabled: .. rst-class:: classref-method |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization`, enabled\: :ref:`bool`\ ) :ref:`🔗` -Toggles the specified customization ``flag``, allowing to customize features available in this **FileDialog**. See :ref:`Customization` for options. +Sets the specified customization ``flag``, allowing to customize the features available in this **FileDialog**. .. rst-class:: classref-item-separator diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst index 1bb6253af..e5cf63acb 100644 --- a/classes/class_foldablecontainer.rst +++ b/classes/class_foldablecontainer.rst @@ -228,7 +228,7 @@ If ``true``, the container will becomes folded and will hide all its children. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for text shaping algorithms. If left empty, current locale is used instead. +Language code used for text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_font.rst b/classes/class_font.rst index 2b2c45013..038675742 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -560,7 +560,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. :ref:`bool` **is_language_supported**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` -Returns ``true``, if font supports given language (`ISO 639 `__ code). +Returns ``true`` if the font supports the given language (as a `ISO 639 `__ code). .. rst-class:: classref-item-separator @@ -572,7 +572,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **is_script_supported**\ (\ script\: :ref:`String`\ ) |const| :ref:`🔗` -Returns ``true``, if font supports given script (`ISO 15924 `__ code). +Returns ``true`` if the font supports the given script (as a `ISO 15924 `__ code). .. rst-class:: classref-item-separator diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 15080551d..7b31cf018 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -291,7 +291,7 @@ Property Descriptions - |void| **set_cast_shadows_setting**\ (\ value\: :ref:`ShadowCastingSetting`\ ) - :ref:`ShadowCastingSetting` **get_cast_shadows_setting**\ (\ ) -The selected shadow casting flag. +The mode used to cast shadows from this instance. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 038cc24aa..da05aa04f 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -314,7 +314,7 @@ If this glTF node has a skin, the index of the :ref:`GLTFSkin` i - |void| **set_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_visible**\ (\ ) -If ``true``, the GLTF node is visible. If ``false``, the GLTF node is not visible. This is translated to the :ref:`Node3D.visible` property in the Godot scene, and is exported to ``KHR_node_visibility`` when ``false``. +If ``true``, the GLTF node is visible. If ``false``, the GLTF node is not visible. This is converted to the :ref:`Node3D.visible` property in the Godot scene, and is exported to ``KHR_node_visibility`` when ``false``. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 77250a8fa..d7813e229 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -89,47 +89,47 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`append_gltf_node`\ (\ gltf_node\: :ref:`GLTFNode`, godot_scene_node\: :ref:`Node`, parent_node_index\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFAccessor`\] | :ref:`get_accessors`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFAccessor`\] | :ref:`get_accessors`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationPlayer` | :ref:`get_animation_player`\ (\ idx\: :ref:`int`\ ) | + | :ref:`AnimationPlayer` | :ref:`get_animation_player`\ (\ anim_player_index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_animation_players_count`\ (\ idx\: :ref:`int`\ ) | + | :ref:`int` | :ref:`get_animation_players_count`\ (\ anim_player_index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFAnimation`\] | :ref:`get_animations`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFAnimation`\] | :ref:`get_animations`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFBufferView`\] | :ref:`get_buffer_views`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFBufferView`\] | :ref:`get_buffer_views`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFCamera`\] | :ref:`get_cameras`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFCamera`\] | :ref:`get_cameras`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_handle_binary_image`\ (\ ) | + | :ref:`int` | :ref:`get_handle_binary_image`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Texture2D`\] | :ref:`get_images`\ (\ ) | + | :ref:`Array`\[:ref:`Texture2D`\] | :ref:`get_images`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFLight`\] | :ref:`get_lights`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFLight`\] | :ref:`get_lights`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Material`\] | :ref:`get_materials`\ (\ ) | + | :ref:`Array`\[:ref:`Material`\] | :ref:`get_materials`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFMesh`\] | :ref:`get_meshes`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFMesh`\] | :ref:`get_meshes`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_index`\ (\ scene_node\: :ref:`Node`\ ) | + | :ref:`int` | :ref:`get_node_index`\ (\ scene_node\: :ref:`Node`\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFNode`\] | :ref:`get_nodes`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFNode`\] | :ref:`get_nodes`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_scene_node`\ (\ idx\: :ref:`int`\ ) | + | :ref:`Node` | :ref:`get_scene_node`\ (\ gltf_node_index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFSkeleton`\] | :ref:`get_skeletons`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFSkeleton`\] | :ref:`get_skeletons`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFSkin`\] | :ref:`get_skins`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFSkin`\] | :ref:`get_skins`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFTextureSampler`\] | :ref:`get_texture_samplers`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFTextureSampler`\] | :ref:`get_texture_samplers`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`GLTFTexture`\] | :ref:`get_textures`\ (\ ) | + | :ref:`Array`\[:ref:`GLTFTexture`\] | :ref:`get_textures`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_animation_names`\ (\ ) | + | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_animation_names`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_names`\ (\ ) | + | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_names`\ (\ ) |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_accessors`\ (\ accessors\: :ref:`Array`\[:ref:`GLTFAccessor`\]\ ) | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -595,7 +595,7 @@ The ``parent_node_index`` parameter is the index of the parent :ref:`GLTFNode`\[:ref:`GLTFAccessor`\] **get_accessors**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFAccessor`\] **get_accessors**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -609,7 +609,7 @@ The ``parent_node_index`` parameter is the index of the parent :ref:`GLTFNode` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Gets additional arbitrary data in this **GLTFState** instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -623,7 +623,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_player**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` +:ref:`AnimationPlayer` **get_animation_player**\ (\ anim_player_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`AnimationPlayer` node with the given index. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to glTF animations. @@ -635,7 +635,7 @@ Returns the :ref:`AnimationPlayer` node with the given in .. rst-class:: classref-method -:ref:`int` **get_animation_players_count**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` +:ref:`int` **get_animation_players_count**\ (\ anim_player_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the number of :ref:`AnimationPlayer` nodes in this **GLTFState**. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to glTF animations. @@ -647,7 +647,7 @@ Returns the number of :ref:`AnimationPlayer` nodes in thi .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFAnimation`\] **get_animations**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFAnimation`\] **get_animations**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFAnimation`\ s in the glTF file. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. @@ -659,7 +659,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the glTF .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFBufferView`\] **get_buffer_views**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFBufferView`\] **get_buffer_views**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -673,7 +673,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the glTF .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFCamera`\] **get_cameras**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFCamera`\] **get_cameras**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFCamera`\ s in the glTF file. These are the cameras that the :ref:`GLTFNode.camera` index refers to. @@ -685,7 +685,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the glTF file. .. rst-class:: classref-method -:ref:`int` **get_handle_binary_image**\ (\ ) :ref:`🔗` +:ref:`int` **get_handle_binary_image**\ (\ ) |const| :ref:`🔗` **Deprecated:** Use :ref:`handle_binary_image_mode` instead. @@ -699,7 +699,7 @@ Deprecated untyped alias for :ref:`handle_binary_image_mode`\[:ref:`Texture2D`\] **get_images**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`Texture2D`\] **get_images**\ (\ ) |const| :ref:`🔗` Gets the images of the glTF file as an array of :ref:`Texture2D`\ s. These are the images that the :ref:`GLTFTexture.src_image` index refers to. @@ -711,7 +711,7 @@ Gets the images of the glTF file as an array of :ref:`Texture2D .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFLight`\] **get_lights**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFLight`\] **get_lights**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFLight`\ s in the glTF file. These are the lights that the :ref:`GLTFNode.light` index refers to. @@ -723,7 +723,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the glTF file. T .. rst-class:: classref-method -:ref:`Array`\[:ref:`Material`\] **get_materials**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`Material`\] **get_materials**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -737,7 +737,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the glTF file. T .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFMesh`\] **get_meshes**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFMesh`\] **get_meshes**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFMesh`\ es in the glTF file. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. @@ -749,7 +749,7 @@ Returns an array of all :ref:`GLTFMesh`\ es in the glTF file. Th .. rst-class:: classref-method -:ref:`int` **get_node_index**\ (\ scene_node\: :ref:`Node`\ ) :ref:`🔗` +:ref:`int` **get_node_index**\ (\ scene_node\: :ref:`Node`\ ) |const| :ref:`🔗` Returns the index of the :ref:`GLTFNode` corresponding to this Godot scene node. This is the inverse of :ref:`get_scene_node()`. Useful during the export process. @@ -763,7 +763,7 @@ Returns the index of the :ref:`GLTFNode` corresponding to this G .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFNode`\] **get_nodes**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFNode`\] **get_nodes**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFNode`\ s in the glTF file. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. This includes nodes that may not be generated in the Godot scene, or nodes that may generate multiple Godot scene nodes. @@ -775,7 +775,7 @@ Returns an array of all :ref:`GLTFNode`\ s in the glTF file. The .. rst-class:: classref-method -:ref:`Node` **get_scene_node**\ (\ idx\: :ref:`int`\ ) :ref:`🔗` +:ref:`Node` **get_scene_node**\ (\ gltf_node_index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the Godot scene node that corresponds to the same index as the :ref:`GLTFNode` it was generated from. This is the inverse of :ref:`get_node_index()`. Useful during the import process. @@ -789,7 +789,7 @@ Returns the Godot scene node that corresponds to the same index as the :ref:`GLT .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFSkeleton`\] **get_skeletons**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFSkeleton`\] **get_skeletons**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFSkeleton`\ s in the glTF file. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. @@ -801,7 +801,7 @@ Returns an array of all :ref:`GLTFSkeleton`\ s in the glTF f .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFSkin`\] **get_skins**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFSkin`\] **get_skins**\ (\ ) |const| :ref:`🔗` Returns an array of all :ref:`GLTFSkin`\ s in the glTF file. These are the skins that the :ref:`GLTFNode.skin` index refers to. @@ -813,7 +813,7 @@ Returns an array of all :ref:`GLTFSkin`\ s in the glTF file. The .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFTextureSampler`\] **get_texture_samplers**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFTextureSampler`\] **get_texture_samplers**\ (\ ) |const| :ref:`🔗` Retrieves the array of texture samplers that are used by the textures contained in the glTF. @@ -825,7 +825,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`Array`\[:ref:`GLTFTexture`\] **get_textures**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`GLTFTexture`\] **get_textures**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -839,7 +839,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **get_unique_animation_names**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`String`\] **get_unique_animation_names**\ (\ ) |const| :ref:`🔗` Returns an array of unique animation names. This is only used during the import process. @@ -851,7 +851,7 @@ Returns an array of unique animation names. This is only used during the import .. rst-class:: classref-method -:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) :ref:`🔗` +:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) |const| :ref:`🔗` Returns an array of unique node names. This is used in both the import process and export process. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 751dd4bd7..2794e7b3b 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -881,7 +881,7 @@ If ``true``, enables snapping. - |void| **set_type_names**\ (\ value\: :ref:`Dictionary`\ ) - :ref:`Dictionary` **get_type_names**\ (\ ) -:ref:`Dictionary` of human readable port type names. +:ref:`Dictionary` of human-readable port type names. .. rst-class:: classref-item-separator @@ -1393,7 +1393,7 @@ See also :ref:`is_valid_connection_type()`\ ) :ref:`🔗` -Disallows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_left_disconnect_type()`. +Disallows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable a disconnection previously allowed with :ref:`add_valid_left_disconnect_type()`. .. rst-class:: classref-item-separator @@ -1405,7 +1405,7 @@ Disallows to disconnect nodes when dragging from the left port of the :ref:`Grap |void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) :ref:`🔗` -Disallows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_right_disconnect_type()`. +Disallows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable a disconnection previously allowed with :ref:`add_valid_right_disconnect_type()`. .. rst-class:: classref-item-separator @@ -1542,7 +1542,7 @@ The outline color of the selection rectangle. :ref:`int` **connection_hover_thickness** = ``0`` :ref:`🔗` -Widen the line of the connection when the mouse is hovering over it by a percentage factor. A value of ``0`` disables the highlight. A value of ``100`` doubles the line width. +Widens the line of a connection when the mouse is hovering over it by a percentage factor. A value of ``0`` disables the highlight. A value of ``100`` doubles the line width. .. rst-class:: classref-item-separator diff --git a/classes/class_graphelement.rst b/classes/class_graphelement.rst index 60913519b..2472bb2a3 100644 --- a/classes/class_graphelement.rst +++ b/classes/class_graphelement.rst @@ -40,6 +40,8 @@ Properties +-------------------------------+---------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`resizable` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`scaling_menus` | ``false`` | + +-------------------------------+---------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`selectable` | ``true`` | +-------------------------------+---------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`selected` | ``false`` | @@ -220,6 +222,23 @@ If ``true``, the user can resize the GraphElement. ---- +.. _class_GraphElement_property_scaling_menus: + +.. rst-class:: classref-property + +:ref:`bool` **scaling_menus** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_scaling_menus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scaling_menus**\ (\ ) + +If ``true``, :ref:`PopupMenu`\ s that are descendants of the GraphElement are scaled with the :ref:`GraphEdit` zoom. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphElement_property_selectable: .. rst-class:: classref-property diff --git a/classes/class_image.rst b/classes/class_image.rst index 7ad416d3e..496c65513 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -1138,7 +1138,7 @@ Copies ``src`` image to this image. **Deprecated:** Use :ref:`create_empty()`. -Creates an empty image of the given size and format. If ``use_mipmaps`` is ``true``, generates mipmaps for this image. See the :ref:`generate_mipmaps()`. +Creates an empty image of the given size and format. If ``use_mipmaps`` is ``true``, generates mipmaps for this image (see :ref:`generate_mipmaps()`). .. rst-class:: classref-item-separator @@ -1150,7 +1150,7 @@ Creates an empty image of the given size and format. If ``use_mipmaps`` is ``tru :ref:`Image` **create_empty**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| :ref:`🔗` -Creates an empty image of the given size and format. If ``use_mipmaps`` is ``true``, generates mipmaps for this image. See the :ref:`generate_mipmaps()`. +Creates an empty image of the given size and format. If ``use_mipmaps`` is ``true``, generates mipmaps for this image (see :ref:`generate_mipmaps()`). .. rst-class:: classref-item-separator diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 6fd4962c1..77bf7eaac 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -38,6 +38,8 @@ Methods +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ImporterMesh` | :ref:`from_mesh`\ (\ mesh\: :ref:`Mesh`\ ) |static| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`generate_lods`\ (\ normal_merge_angle\: :ref:`float`, normal_split_angle\: :ref:`float`, bone_transform_array\: :ref:`Array`\ ) | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_shape_count`\ (\ ) |const| | @@ -136,6 +138,18 @@ Removes all surfaces and blend shapes from this **ImporterMesh**. ---- +.. _class_ImporterMesh_method_from_mesh: + +.. rst-class:: classref-method + +:ref:`ImporterMesh` **from_mesh**\ (\ mesh\: :ref:`Mesh`\ ) |static| :ref:`🔗` + +Converts the given :ref:`Mesh` into an **ImporterMesh** by copying all its surfaces, blend shapes, materials, and metadata into a new **ImporterMesh** object. + +.. rst-class:: classref-item-separator + +---- + .. _class_ImporterMesh_method_generate_lods: .. rst-class:: classref-method diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 1b2814fa1..914bd13b9 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -68,10 +68,14 @@ Properties +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`same_column_width` | ``false`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`ScrollHintMode` | :ref:`scroll_hint_mode` | ``0`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`SelectMode` | :ref:`select_mode` | ``0`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`OverrunBehavior` | :ref:`text_overrun_behavior` | ``3`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tile_scroll_hint` | ``false`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`wraparound_items` | ``true`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ @@ -189,51 +193,53 @@ Theme Properties .. table:: :widths: auto - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_color` | ``Color(0.65, 0.65, 0.65, 1)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_hovered_color` | ``Color(0.95, 0.95, 0.95, 1)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_hovered_selected_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`font_selected_color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Color` | :ref:`guide_color` | ``Color(0.7, 0.7, 0.7, 0.25)`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`h_separation` | ``4`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`icon_margin` | ``4`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`line_separation` | ``2`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`outline_size` | ``0`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`v_separation` | ``4`` | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`Font` | :ref:`font` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`int` | :ref:`font_size` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`cursor` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`cursor_unfocused` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`hovered` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`hovered_selected` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`hovered_selected_focus` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`panel` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`selected` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ - | :ref:`StyleBox` | :ref:`selected_focus` | | - +---------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(0.65, 0.65, 0.65, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_hovered_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_hovered_selected_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(0, 0, 0, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_selected_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`guide_color` | ``Color(0.7, 0.7, 0.7, 0.25)`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`h_separation` | ``4`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`icon_margin` | ``4`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`line_separation` | ``2`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`v_separation` | ``4`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Font` | :ref:`font` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`int` | :ref:`font_size` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`Texture2D` | :ref:`scroll_hint` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`cursor` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`cursor_unfocused` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`hovered` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected_focus` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`panel` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`selected` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`selected_focus` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+--------------------------------+ .. rst-class:: classref-section-separator @@ -371,6 +377,48 @@ Allows selecting multiple items by holding :kbd:`Ctrl` or :kbd:`Shift`. Allows selecting multiple items by toggling them on and off. +.. rst-class:: classref-item-separator + +---- + +.. _enum_ItemList_ScrollHintMode: + +.. rst-class:: classref-enumeration + +enum **ScrollHintMode**: :ref:`🔗` + +.. _class_ItemList_constant_SCROLL_HINT_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_DISABLED** = ``0`` + +Scroll hints will never be shown. + +.. _class_ItemList_constant_SCROLL_HINT_MODE_BOTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_BOTH** = ``1`` + +Scroll hints will be shown at the top and bottom. + +.. _class_ItemList_constant_SCROLL_HINT_MODE_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_TOP** = ``2`` + +Only the top scroll hint will be shown. + +.. _class_ItemList_constant_SCROLL_HINT_MODE_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_BOTTOM** = ``3`` + +Only the bottom scroll hint will be shown. + .. rst-class:: classref-section-separator ---- @@ -613,6 +661,23 @@ If ``true``, the width is equal to the largest column width of all columns. ---- +.. _class_ItemList_property_scroll_hint_mode: + +.. rst-class:: classref-property + +:ref:`ScrollHintMode` **scroll_hint_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_scroll_hint_mode**\ (\ value\: :ref:`ScrollHintMode`\ ) +- :ref:`ScrollHintMode` **get_scroll_hint_mode**\ (\ ) + +The way which scroll hints (indicators that show that the content can still be scrolled in a certain direction) will be shown. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_property_select_mode: .. rst-class:: classref-property @@ -647,6 +712,23 @@ The clipping behavior when the text exceeds an item's bounding rectangle. ---- +.. _class_ItemList_property_tile_scroll_hint: + +.. rst-class:: classref-property + +:ref:`bool` **tile_scroll_hint** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tile_scroll_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_hint_tiled**\ (\ ) + +If ``true``, the scroll hint texture will be tiled instead of stretched. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_property_wraparound_items: .. rst-class:: classref-property @@ -1177,7 +1259,7 @@ Sets whether the item icon will be drawn transposed. |void| **set_item_language**\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` -Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Sets the language code of the text for the item at the given index to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used. .. rst-class:: classref-item-separator @@ -1430,6 +1512,18 @@ Font size of the item's text. ---- +.. _class_ItemList_theme_icon_scroll_hint: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **scroll_hint** :ref:`🔗` + +The indicator that will be shown when the content can still be scrolled. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_theme_style_cursor: .. rst-class:: classref-themeproperty @@ -1460,7 +1554,7 @@ Font size of the item's text. :ref:`StyleBox` **focus** :ref:`🔗` -The focused style for the **ItemList**, drawn on top of the background, but below everything else. +The focused style for the **ItemList**, drawn on top of everything. .. rst-class:: classref-item-separator diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index 55d0ac301..cede8e0d6 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -215,9 +215,9 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act Registers a callback for the given method name. -- ``name`` The name that clients can use to access the callback. +- ``name``: The name that clients can use to access the callback. -- ``callback`` The callback which will handle the specific method. +- ``callback``: The callback which will handle the specified method. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_label.rst b/classes/class_label.rst index fe0dc5b71..4751ab8fe 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -284,7 +284,7 @@ A :ref:`LabelSettings` resource that can be shared between - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index e9bbdacf2..b5ca353b9 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -490,7 +490,7 @@ Line fill alignment rules. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index b8941a6a7..14186fb48 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -133,6 +133,8 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`ExpandMode` | :ref:`icon_expand_mode` | ``0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`keep_editing_on_text_submit` | ``false`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | @@ -147,6 +149,8 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`right_icon` | | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`right_icon_scale` | ``1.0`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`secret` | ``false`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`secret_character` | ``"•"`` | @@ -680,6 +684,40 @@ Virtual keyboard for entering a password. On most platforms, this should disable Virtual keyboard with additional keys to assist with typing URLs. +.. rst-class:: classref-item-separator + +---- + +.. _enum_LineEdit_ExpandMode: + +.. rst-class:: classref-enumeration + +enum **ExpandMode**: :ref:`🔗` + +.. _class_LineEdit_constant_EXPAND_MODE_ORIGINAL_SIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ExpandMode` **EXPAND_MODE_ORIGINAL_SIZE** = ``0`` + +Use the original size for the right icon. + +.. _class_LineEdit_constant_EXPAND_MODE_FIT_TO_TEXT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ExpandMode` **EXPAND_MODE_FIT_TO_TEXT** = ``1`` + +Scale the right icon's size to match the size of the text. + +.. _class_LineEdit_constant_EXPAND_MODE_FIT_TO_LINE_EDIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ExpandMode` **EXPAND_MODE_FIT_TO_LINE_EDIT** = ``2`` + +Scale the right icon to fit the LineEdit. + .. rst-class:: classref-section-separator ---- @@ -700,7 +738,7 @@ Property Descriptions - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -Text alignment as defined in the :ref:`HorizontalAlignment` enum. +The text's horizontal alignment. .. rst-class:: classref-item-separator @@ -963,6 +1001,23 @@ If ``true``, the **LineEdit** doesn't display decoration. ---- +.. _class_LineEdit_property_icon_expand_mode: + +.. rst-class:: classref-property + +:ref:`ExpandMode` **icon_expand_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_icon_expand_mode**\ (\ value\: :ref:`ExpandMode`\ ) +- :ref:`ExpandMode` **get_icon_expand_mode**\ (\ ) + +Define the scaling behavior of the :ref:`right_icon`. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_property_keep_editing_on_text_submit: .. rst-class:: classref-property @@ -991,7 +1046,7 @@ If ``true``, the **LineEdit** will not exit edit mode when text is submitted by - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator @@ -1096,6 +1151,23 @@ Sets the icon that will appear in the right end of the **LineEdit** if there's n ---- +.. _class_LineEdit_property_right_icon_scale: + +.. rst-class:: classref-property + +:ref:`float` **right_icon_scale** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_right_icon_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_right_icon_scale**\ (\ ) + +Scale ratio of the icon when :ref:`icon_expand_mode` is set to :ref:`EXPAND_MODE_FIT_TO_LINE_EDIT`. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_property_secret: .. rst-class:: classref-property diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index c0b45f222..363412fb1 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -165,7 +165,7 @@ Ellipsis character used for text clipping. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_menubar.rst b/classes/class_menubar.rst index 9eb17ad2d..762158285 100644 --- a/classes/class_menubar.rst +++ b/classes/class_menubar.rst @@ -168,7 +168,7 @@ Flat **MenuBar** don't display item decoration. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator @@ -305,7 +305,7 @@ Returns menu item tooltip. :ref:`bool` **is_menu_disabled**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` -Returns ``true``, if menu item is disabled. +Returns ``true`` if the menu item is disabled. .. rst-class:: classref-item-separator @@ -317,7 +317,7 @@ Returns ``true``, if menu item is disabled. :ref:`bool` **is_menu_hidden**\ (\ menu\: :ref:`int`\ ) |const| :ref:`🔗` -Returns ``true``, if menu item is hidden. +Returns ``true`` if the menu item is hidden. .. rst-class:: classref-item-separator @@ -329,7 +329,7 @@ Returns ``true``, if menu item is hidden. :ref:`bool` **is_native_menu**\ (\ ) |const| :ref:`🔗` -Returns ``true``, if system global menu is supported and used by this **MenuBar**. +Returns ``true`` if the current system's global menu is supported and used by this **MenuBar**. .. rst-class:: classref-item-separator diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 1275c5f34..08de46016 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -23,8 +23,6 @@ A synchronization mutex (mutual exclusion). This is used to synchronize multiple This is a reentrant mutex, meaning that it can be locked multiple times by one thread, provided it also unlocks it as many times. -\ **Warning:** Mutexes must be used carefully to avoid deadlocks. - \ **Warning:** To ensure proper cleanup without crashes or deadlocks, the following conditions must be met: - When a **Mutex**'s reference count reaches zero and it is therefore destroyed, no threads (including the one on which the destruction will happen) must have it locked. diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index f273124bc..4ad23a5f5 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -177,7 +177,7 @@ enum **SamplePartitionType**: :ref:`🔗` **SAMPLE_PARTITION_CONVEX_PARTITION** = ``0`` -Convex partitioning that yields navigation mesh with convex polygons. +Convex partitioning that results in a navigation mesh with convex polygons. .. _class_NavigationPolygon_constant_SAMPLE_PARTITION_TRIANGULATE: @@ -185,7 +185,7 @@ Convex partitioning that yields navigation mesh with convex polygons. :ref:`SamplePartitionType` **SAMPLE_PARTITION_TRIANGULATE** = ``1`` -Triangulation partitioning that yields navigation mesh with triangle polygons. +Triangulation partitioning that results in a navigation mesh with triangle polygons. .. _class_NavigationPolygon_constant_SAMPLE_PARTITION_MAX: diff --git a/classes/class_node.rst b/classes/class_node.rst index 7f8c76cd4..b36003d35 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1763,7 +1763,7 @@ Use :ref:`add_child()` instead of this method if yo Adds the node to the ``group``. Groups can be helpful to organize a subset of nodes, for example ``"enemies"`` or ``"collectables"``. See notes in the description, and the group methods in :ref:`SceneTree`. -If ``persistent`` is ``true``, the group will be stored when saved inside a :ref:`PackedScene`. All groups created and displayed in the Node dock are persistent. +If ``persistent`` is ``true``, the group will be stored when saved inside a :ref:`PackedScene`. All groups created and displayed in the Groups dock are persistent. \ **Note:** To improve performance, the order of group names is *not* guaranteed and may vary between project runs. Therefore, do not rely on the group order. @@ -2738,7 +2738,7 @@ Similar to :ref:`call_thread_safe()`, but fo Prints all orphan nodes (nodes outside the :ref:`SceneTree`). Useful for debugging. -\ **Note:** This method only works in debug builds. Does nothing in a project exported in release mode. +\ **Note:** This method only works in debug builds. It does nothing in a project exported in release mode. .. rst-class:: classref-item-separator diff --git a/classes/class_object.rst b/classes/class_object.rst index ffeb753d9..0046a2492 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -256,7 +256,7 @@ Deferred connections trigger their :ref:`Callable`\ s on idle ti :ref:`ConnectFlags` **CONNECT_PERSIST** = ``2`` -Persisting connections are stored when the object is serialized (such as when using :ref:`PackedScene.pack()`). In the editor, connections created through the Node dock are always persisting. +Persisting connections are stored when the object is serialized (such as when using :ref:`PackedScene.pack()`). In the editor, connections created through the Signals dock are always persisting. .. _class_Object_constant_CONNECT_ONE_SHOT: @@ -912,6 +912,8 @@ This method supports a variable number of arguments, so parameters can be passed +For methods that are deferred from the same thread, the order of execution at idle time is identical to the order in which ``call_deferred`` was called. + See also :ref:`Callable.call_deferred()`. \ **Note:** In C#, ``method`` must be in snake_case when referring to built-in Godot methods. Prefer using the names exposed in the ``MethodName`` class to avoid allocating a new :ref:`StringName` on each call. @@ -998,7 +1000,7 @@ A signal can only be connected once to the same :ref:`Callable`. \ **Note:** In GDScript, it is generally recommended to connect signals with :ref:`Signal.connect()` instead. -\ **Note:** This operation (and all other signal related operations) is thread-safe. +\ **Note:** This method, and all other signal-related methods, are thread-safe. .. rst-class:: classref-item-separator @@ -1305,7 +1307,7 @@ Returns an :ref:`Array` of connections for the given ``signal`` nam Returns the list of existing signals as an :ref:`Array` of dictionaries. -\ **Note:** Due of the implementation, each :ref:`Dictionary` is formatted very similarly to the returned values of :ref:`get_method_list()`. +\ **Note:** Due to the implementation, each :ref:`Dictionary` is formatted very similarly to the returned values of :ref:`get_method_list()`. .. rst-class:: classref-item-separator diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index e8df73d73..d00c952f5 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -71,6 +71,8 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_next_frame_time`\ (\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_openxr_version`\ (\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_play_space`\ (\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_predicted_display_time`\ (\ ) | @@ -314,6 +316,18 @@ Returns the predicted display timing for the next frame. ---- +.. _class_OpenXRAPIExtension_method_get_openxr_version: + +.. rst-class:: classref-method + +:ref:`int` **get_openxr_version**\ (\ ) :ref:`🔗` + +Returns the version of OpenXR that was initialized. Only valid after the OpenXR instance has been created. See `XR_MAKE_VERSION `__ for how the version is calculated. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_get_play_space: .. rst-class:: classref-method diff --git a/classes/class_openxrextensionwrapper.rst b/classes/class_openxrextensionwrapper.rst index d77a4405f..55abac633 100644 --- a/classes/class_openxrextensionwrapper.rst +++ b/classes/class_openxrextensionwrapper.rst @@ -48,7 +48,7 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | + | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ xr_version\: :ref:`int`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -112,7 +112,7 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_set_hand_joint_locations_and_get_next_pointer`\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer`\ (\ xr_version\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_set_projection_views_and_get_next_pointer`\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -196,9 +196,9 @@ This will only be called if the extension previously registered itself with :ref .. rst-class:: classref-method -:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| :ref:`🔗` +:ref:`Dictionary` **_get_requested_extensions**\ (\ xr_version\: :ref:`int`\ ) |virtual| :ref:`🔗` -Returns a :ref:`Dictionary` of OpenXR extensions related to this extension. The :ref:`Dictionary` should contain the name of the extension, mapped to a ``bool *`` cast to an integer: +Returns a :ref:`Dictionary` of OpenXR extensions related to this extension. ``xr_version`` specifies the OpenXR version we're instantiating. This will be zero if the editor requests this list to flag supported features. The :ref:`Dictionary` should contain the name of the extension, mapped to a ``bool *`` cast to an integer: - If the ``bool *`` is a ``nullptr`` this extension is mandatory. @@ -622,9 +622,9 @@ Add additional data structures when each hand tracker is created. .. rst-class:: classref-method -:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` +:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ xr_version\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` -Add additional data structures when the OpenXR instance is created. +Add additional data structures when the OpenXR instance is created. ``xr_version`` specifies the OpenXR version we're instantiating. .. rst-class:: classref-item-separator diff --git a/classes/class_openxrinteractionprofilemetadata.rst b/classes/class_openxrinteractionprofilemetadata.rst index fae072322..3b9826a69 100644 --- a/classes/class_openxrinteractionprofilemetadata.rst +++ b/classes/class_openxrinteractionprofilemetadata.rst @@ -29,15 +29,17 @@ Methods .. table:: :widths: auto - +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_interaction_profile`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) | - +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_io_path`\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) | - +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_profile_rename`\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) | - +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_top_level_path`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) | - +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_interaction_profile`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_io_path`\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`, action_type\: :ref:`ActionType`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_path_rename`\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_profile_rename`\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_top_level_path`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,11 +54,11 @@ Method Descriptions .. rst-class:: classref-method -|void| **register_interaction_profile**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) :ref:`🔗` +|void| **register_interaction_profile**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`\ ) :ref:`🔗` Registers an interaction profile using its OpenXR designation (e.g. ``/interaction_profiles/khr/simple_controller`` is the profile for OpenXR's simple controller profile). -\ ``display_name`` is the description shown to the user. ``openxr_path`` is the interaction profile path being registered. ``openxr_extension_name`` optionally restricts this profile to the given extension being enabled/available. If the extension is not available, the profile and all related entries used in an action map are filtered out. +\ ``display_name`` is the description shown to the user. ``openxr_path`` is the interaction profile path being registered. ``openxr_extension_names`` optionally restricts this profile to the given extension being enabled/available. If the extension is not available, the profile and all related entries used in an action map are filtered out. .. rst-class:: classref-item-separator @@ -66,9 +68,21 @@ Registers an interaction profile using its OpenXR designation (e.g. ``/interacti .. rst-class:: classref-method -|void| **register_io_path**\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) :ref:`🔗` +|void| **register_io_path**\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`, action_type\: :ref:`ActionType`\ ) :ref:`🔗` -Registers an input/output path for the given ``interaction_profile``. The profile should previously have been registered using :ref:`register_interaction_profile()`. ``display_name`` is the description shown to the user. ``toplevel_path`` specifies the bind path this input/output can be bound to (e.g. ``/user/hand/left`` or ``/user/hand/right``). ``openxr_path`` is the action input/output being registered (e.g. ``/user/hand/left/input/aim/pose``). ``openxr_extension_name`` restricts this input/output to an enabled/available extension, this doesn't need to repeat the extension on the profile but relates to overlapping extension (e.g. ``XR_EXT_palm_pose`` that introduces ``…/input/palm_ext/pose`` input paths). ``action_type`` defines the type of input or output provided by OpenXR. +Registers an input/output path for the given ``interaction_profile``. The profile should previously have been registered using :ref:`register_interaction_profile()`. ``display_name`` is the description shown to the user. ``toplevel_path`` specifies the bind path this input/output can be bound to (e.g. ``/user/hand/left`` or ``/user/hand/right``). ``openxr_path`` is the action input/output being registered (e.g. ``/user/hand/left/input/aim/pose``). ``openxr_extension_names`` restricts this input/output to an enabled/available extension, this doesn't need to repeat the extension on the profile but relates to overlapping extension (e.g. ``XR_EXT_palm_pose`` that introduces ``…/input/palm_ext/pose`` input paths). ``action_type`` defines the type of input or output provided by OpenXR. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInteractionProfileMetadata_method_register_path_rename: + +.. rst-class:: classref-method + +|void| **register_path_rename**\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) :ref:`🔗` + +Allows for renaming old input/output paths to new paths in order to load and process older action maps. .. rst-class:: classref-item-separator @@ -80,7 +94,7 @@ Registers an input/output path for the given ``interaction_profile``. The profil |void| **register_profile_rename**\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) :ref:`🔗` -Allows for renaming old interaction profile paths to new paths to maintain backwards compatibility with older action maps. +Allows for renaming old interaction profile paths to new paths in order to load and process older action maps. .. rst-class:: classref-item-separator @@ -90,11 +104,11 @@ Allows for renaming old interaction profile paths to new paths to maintain backw .. rst-class:: classref-method -|void| **register_top_level_path**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) :ref:`🔗` +|void| **register_top_level_path**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_names\: :ref:`String`\ ) :ref:`🔗` Registers a top level path to which profiles can be bound. For instance ``/user/hand/left`` refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register ``/user/body/vest``. -\ ``display_name`` is the name shown to the user. ``openxr_path`` is the top level path being registered. ``openxr_extension_name`` is optional and ensures the top level path is only used if the specified extension is available/enabled. +\ ``display_name`` is the name shown to the user. ``openxr_path`` is the top level path being registered. ``openxr_extension_names`` is optional and ensures the top level path is only used if the specified extension is available/enabled. When a top level path ends up being bound by OpenXR, an :ref:`XRPositionalTracker` is instantiated to manage the state of the device. diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index cf9d6319e..19dc2af27 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -330,7 +330,7 @@ The session is about to be lost. :ref:`session_loss_pending` **SESSION_STATE_EXITING** = ``8`` -The OpenXR instance is about to be destroyed and we're existing. :ref:`instance_exiting` is emitted when we change to this state. +The OpenXR instance is about to be destroyed and we're exiting. :ref:`instance_exiting` is emitted when we change to this state. .. rst-class:: classref-item-separator @@ -881,7 +881,7 @@ The display refresh rate for the current HMD. Only functional if this feature is - |void| **set_foveation_dynamic**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_foveation_dynamic**\ (\ ) -Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and :ref:`foveation_level`. +If ``true``, enables dynamic foveation adjustment. The interface must be initialized before this is accessible. If enabled, foveation will automatically be adjusted between low and :ref:`foveation_level`. \ **Note:** Only works on the Compatibility renderer. @@ -900,7 +900,7 @@ Enable dynamic foveation adjustment, the interface must be initialized before th - |void| **set_foveation_level**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_foveation_level**\ (\ ) -Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible. +The foveation level, from ``0`` (off) to ``3`` (high). The interface must be initialized before this is accessible. \ **Note:** Only works on the Compatibility renderer. @@ -986,7 +986,7 @@ Returns a list of action sets registered with Godot (loaded from the action map :ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| :ref:`🔗` -Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. +Returns a list of display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. .. rst-class:: classref-item-separator @@ -1146,9 +1146,9 @@ Returns the capabilities of the eye gaze interaction extension. :ref:`bool` **is_foveation_supported**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value. +Returns ``true`` if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value. -\ **Note:** This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set :ref:`Viewport.vrs_mode` to ``VRS_XR`` on desktop. +\ **Note:** When using the Vulkan rendering driver, :ref:`Viewport.vrs_mode` must be set to :ref:`Viewport.VRS_XR` to support foveation. .. rst-class:: classref-item-separator diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index 44a84dee5..3e502300e 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -56,7 +56,7 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedByteArray`\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`bswap16`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -283,7 +283,7 @@ Appends a **PackedByteArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -751,7 +751,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the byte at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0``. +Returns the byte at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 3aad4e146..a31602977 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -51,53 +51,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedColorArray`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Color`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`duplicate`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Color`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Color`\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`duplicate`\ (\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Color`\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :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 @@ -197,7 +197,7 @@ Appends a **PackedColorArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -285,7 +285,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`Color` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the :ref:`Color` at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``Color(0, 0, 0, 1)``. +Returns the :ref:`Color` at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``Color(0, 0, 0, 1)``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 22d2c2cbb..e4ce20cd0 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -51,53 +51,53 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat32Array`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`duplicate`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`duplicate`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :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 @@ -191,7 +191,7 @@ Appends a **PackedFloat32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -287,7 +287,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`float` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the 32-bit float at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0.0``. +Returns the 32-bit float at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0.0``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index bab2660dc..5aa9973d2 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -53,53 +53,53 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat64Array`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`duplicate`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`duplicate`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :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 @@ -193,7 +193,7 @@ Appends a **PackedFloat64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -289,7 +289,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`float` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the 64-bit float at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0.0``. +Returns the 64-bit float at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0.0``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index c37a71657..6fcb5aa31 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -51,53 +51,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt32Array`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`duplicate`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`duplicate`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :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 @@ -191,7 +191,7 @@ Appends a **PackedInt32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -279,7 +279,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the 32-bit integer at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0``. +Returns the 32-bit integer at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 2f32fcd68..b3356f745 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -53,53 +53,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt64Array`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`duplicate`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`duplicate`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :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 @@ -193,7 +193,7 @@ Appends a **PackedInt64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -281,7 +281,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`int` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the 64-bit integer at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0``. +Returns the 64-bit integer at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``0``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index 9d785db3d..d94ccd64a 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -66,53 +66,53 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedStringArray`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`String`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`duplicate`\ (\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`String`\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`duplicate`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :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 @@ -206,7 +206,7 @@ Appends a **PackedStringArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -294,9 +294,9 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`String` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the :ref:`String` at the given ``index`` in the array. Returns an empty string and prints an error if the access is out of bounds. Negative indices are not supported; they will always consider the value to be out of bounds and return an empty string. +Returns the :ref:`String` at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns an empty string. -This is similar to using the ``[]`` operator (``array[index]``), except that operator supports negative indices and causes a debugger break if out-of-bounds access is performed. +This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. .. rst-class:: classref-item-separator diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index aa3e5a3e5..d14ed69ff 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -58,53 +58,53 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector2Array`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector2`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`duplicate`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector2`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`duplicate`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :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 @@ -206,7 +206,7 @@ Appends a **PackedVector2Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -302,7 +302,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`Vector2` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the :ref:`Vector2` at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``Vector2(0, 0)``. +Returns the :ref:`Vector2` at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``Vector2(0, 0)``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index 828dee41d..40b1e1535 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -51,53 +51,53 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector3Array`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector3`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`duplicate`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector3`\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reverse`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`sort`\ (\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`duplicate`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :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 @@ -199,7 +199,7 @@ Appends a **PackedVector3Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -295,7 +295,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`Vector3` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the :ref:`Vector3` at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``Vector3(0, 0, 0)``. +Returns the :ref:`Vector3` at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``Vector3(0, 0, 0)``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_packedvector4array.rst b/classes/class_packedvector4array.rst index 61d9fb993..c18c12671 100644 --- a/classes/class_packedvector4array.rst +++ b/classes/class_packedvector4array.rst @@ -51,53 +51,53 @@ 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`\ (\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector4`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`fill`\ (\ value\: :ref:`Vector4`\ ) | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`get`\ (\ index\: :ref:`int`\ ) |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| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :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\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector4`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector4Array` | :ref:`duplicate`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector4`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector4`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`get`\ (\ index\: :ref:`int`\ ) |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 @@ -197,7 +197,7 @@ Appends a **PackedVector4Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch**\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) :ref:`🔗` +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector4`, before\: :ref:`bool` = true\ ) |const| :ref:`🔗` 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. @@ -293,7 +293,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt :ref:`Vector4` **get**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the :ref:`Vector4` at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``Vector4(0, 0, 0, 0)``. +Returns the :ref:`Vector4` at the given ``index`` in the array. If ``index`` is out-of-bounds or negative, this method fails and returns ``Vector4(0, 0, 0, 0)``. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor. diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index afd3f5aae..8b7ae5798 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -709,7 +709,7 @@ Property Descriptions The alpha value of each particle's color will be multiplied by this :ref:`CurveTexture` over its lifetime. -\ **Note:** :ref:`alpha_curve` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`alpha_curve` will have no visible effect. +\ **Note:** :ref:`alpha_curve` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALPHA *= COLOR.a;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`alpha_curve` will have no visible effect. .. rst-class:: classref-item-separator diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index edaec4377..30f713556 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -103,9 +103,7 @@ A :ref:`Curve3D` describing the path. - |void| **set_debug_custom_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_debug_custom_color**\ (\ ) -The custom color to use to draw the shape in the editor. - -If set to ``Color(0.0, 0.0, 0.0)`` (by default), the color set in EditorSettings is used. +The custom color used to draw the path in the editor. If set to :ref:`Color.BLACK` (as by default), the color set in :ref:`ProjectSettings.debug/shapes/paths/geometry_color` is used. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_performance.rst b/classes/class_performance.rst index ea467a98e..afcb803cb 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -270,7 +270,7 @@ Output latency of the :ref:`AudioServer`. Equivalent to calli :ref:`Monitor` **NAVIGATION_ACTIVE_MAPS** = ``24`` -Number of active navigation maps in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. This also includes the two empty default navigation maps created by World2D and World3D. +Number of active navigation maps in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. This also includes the empty default navigation maps created by :ref:`World2D` and :ref:`World3D` instances. .. _class_Performance_constant_NAVIGATION_REGION_COUNT: @@ -390,7 +390,7 @@ Number of pipeline compilations that were triggered to optimize the current scen :ref:`Monitor` **NAVIGATION_2D_ACTIVE_MAPS** = ``39`` -Number of active navigation maps in the :ref:`NavigationServer2D`. This also includes the two empty default navigation maps created by World2D. +Number of active navigation maps in the :ref:`NavigationServer2D`. This also includes the empty default navigation maps created by :ref:`World2D` instances. .. _class_Performance_constant_NAVIGATION_2D_REGION_COUNT: @@ -470,7 +470,7 @@ Number of active navigation obstacles in the :ref:`NavigationServer2D` **NAVIGATION_3D_ACTIVE_MAPS** = ``49`` -Number of active navigation maps in the :ref:`NavigationServer3D`. This also includes the two empty default navigation maps created by World3D. +Number of active navigation maps in the :ref:`NavigationServer3D`. This also includes the empty default navigation maps created by :ref:`World3D` instances. .. _class_Performance_constant_NAVIGATION_3D_REGION_COUNT: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 77e86c6e1..1a92af079 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -324,7 +324,7 @@ Emitted when the user navigated to an item of some ``id`` using the :ref:`Projec **id_pressed**\ (\ id\: :ref:`int`\ ) :ref:`🔗` -Emitted when an item of some ``id`` is pressed or its accelerator is activated. +Emitted when an item of some ``id`` is pressed. Also emitted when its accelerator is activated on macOS. \ **Note:** If ``id`` is negative (either explicitly or due to overflow), this will return the corresponding index instead. @@ -338,7 +338,7 @@ Emitted when an item of some ``id`` is pressed or its accelerator is activated. **index_pressed**\ (\ index\: :ref:`int`\ ) :ref:`🔗` -Emitted when an item of some ``index`` is pressed or its accelerator is activated. +Emitted when an item of some ``index`` is pressed. Also emitted when its accelerator is activated on macOS. .. rst-class:: classref-item-separator @@ -1324,7 +1324,7 @@ Sets the horizontal offset of the item at the given ``index``. |void| **set_item_language**\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` -Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Sets the language code of the text for the item at the given index to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used. .. rst-class:: classref-item-separator diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index a44eb2af8..c157e5377 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -186,11 +186,9 @@ Property Descriptions - |void| **set_keep_compressed_buffer**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_keeping_compressed_buffer**\ (\ ) -When running on the editor, this class will keep the source compressed data in memory. Otherwise, the source compressed data is lost after loading and the resource can't be re saved. +If ``true``, when running in the editor, this texture will keep the source-compressed data in memory, allowing the data to persist after loading. Otherwise, the source-compressed data is lost after loading and the texture can't be re-saved. -This flag allows to keep the compressed data in memory if you intend it to persist after loading. - -\ **Note:** This must be set before :ref:`create_from_image()` to take effect. +\ **Note:** This property must be set before :ref:`create_from_image()` for this to work. .. rst-class:: classref-item-separator @@ -207,7 +205,7 @@ This flag allows to keep the compressed data in memory if you intend it to persi - |void| **set_size_override**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_size_override**\ (\ ) -Allow overriding the texture size (for 2D only). +Allows overriding the texture's size (for 2D only). .. rst-class:: classref-section-separator @@ -264,7 +262,7 @@ Return the image format used (valid after initialized). :ref:`bool` **is_keeping_all_compressed_buffers**\ (\ ) |static| :ref:`🔗` -Return whether the flag is overridden for all textures of this type. +Returns ``true`` if the flag is overridden for all textures of this type. .. rst-class:: classref-item-separator @@ -278,7 +276,7 @@ Return whether the flag is overridden for all textures of this type. Sets the compressor parameters for Basis Universal compression. See also the settings in :ref:`ResourceImporterTexture`. -\ **Note:** This must be set before :ref:`create_from_image()` to take effect. +\ **Note:** This method must be called before :ref:`create_from_image()` for this to work. .. rst-class:: classref-item-separator @@ -290,7 +288,7 @@ Sets the compressor parameters for Basis Universal compression. See also the set |void| **set_keep_all_compressed_buffers**\ (\ keep\: :ref:`bool`\ ) |static| :ref:`🔗` -Overrides the flag globally for all textures of this type. This is used primarily by the editor. +If ``keep`` is ``true``, overrides the flag globally for all textures of this type. This is used primarily by the editor. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 33e8314db..e67856801 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1717,7 +1717,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/reflections/sky_reflections/ggx_samples.mobile` | ``16`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/reflections/sky_reflections/roughness_layers` | ``8`` | + | :ref:`int` | :ref:`rendering/reflections/sky_reflections/roughness_layers` | ``7`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1733,11 +1733,9 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/rendering_device/d3d12/agility_sdk_version` | ``613`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_misc_descriptors_per_frame` | ``512`` | + | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_resource_descriptors` | ``65536`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_resource_descriptors_per_frame` | ``16384`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame` | ``1024`` | + | :ref:`int` | :ref:`rendering/rendering_device/d3d12/max_sampler_descriptors` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/rendering_device/driver` | ``"vulkan"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -2006,7 +2004,7 @@ Accessibility support mode: - **Disabled** (``2``): Accessibility support is fully disabled. -\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD) do not count as assistive apps. To test your project with these tools, use **Always Active**. +\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test your project with these tools, use **Always Active**. .. rst-class:: classref-item-separator @@ -2752,9 +2750,9 @@ Sets the `AVAudioSessionCategory ` **audio/general/text_to_speech** = ``false`` :ref:`🔗` -If ``true``, text-to-speech support is enabled on startup, otherwise it is enabled first time TTS method is used, see :ref:`DisplayServer.tts_get_voices()` and :ref:`DisplayServer.tts_speak()`. +If ``true``, text-to-speech support is enabled on startup, otherwise it is enabled the first time any TTS method is used. See also :ref:`DisplayServer.tts_get_voices()` and :ref:`DisplayServer.tts_speak()`. -\ **Note:** Enabling TTS can cause addition idle CPU usage and interfere with the sleep mode, so consider disabling it if TTS is not used. +\ **Note:** Enabling TTS can cause additional idle CPU usage and interfere with the sleep mode, so consider disabling it if TTS is not used. .. rst-class:: classref-item-separator @@ -4972,9 +4970,17 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` :ref:`String` **display/window/stretch/aspect** = ``"keep"`` :ref:`🔗` -.. container:: contribute +Defines how the aspect ratio of the base size is preserved when stretching to fit the resolution of the window or screen. - There is currently no description for this property. Please help us by `contributing one `__! +\ ``"ignore"``: Ignore the aspect ratio when stretching the screen. This means that the original resolution will be stretched to exactly fill the screen, even if it's wider or narrower. This may result in non-uniform stretching: things looking wider or taller than designed. + +\ ``"keep"``: Keep aspect ratio when stretching the screen. This means that the viewport retains its original size regardless of the screen resolution, and black bars will be added to the top/bottom of the screen ("letterboxing") or the sides ("pillarboxing"). + +\ ``"keep_width"``: Keep aspect ratio when stretching the screen. If the screen is wider than the base size, black bars are added at the left and right (pillarboxing). But if the screen is taller than the base resolution, the viewport will be grown in the vertical direction (and more content will be visible at the bottom). You can also think of this as "Expand Vertically". + +\ ``"keep_height"``: Keep aspect ratio when stretching the screen. If the screen is taller than the base size, black bars are added at the top and bottom (letterboxing). But if the screen is wider than the base resolution, the viewport will be grown in the horizontal direction (and more content will be visible to the right). You can also think of this as "Expand Horizontally". + +\ ``"expand"``: Keep aspect ratio when stretching the screen, but keep neither the base width nor height. Depending on the screen aspect ratio, the viewport will either be larger in the horizontal direction (if the screen is wider than the base size) or in the vertical direction (if the screen is taller than the original size). .. rst-class:: classref-item-separator @@ -4988,11 +4994,11 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` Defines how the base size is stretched to fit the resolution of the window or screen. -\ **"disabled"**: No stretching happens. One unit in the scene corresponds to one pixel on the screen. In this mode, :ref:`display/window/stretch/aspect` has no effect. Recommended for non-game applications. +\ ``"disabled"``: No stretching happens. One unit in the scene corresponds to one pixel on the screen. In this mode, :ref:`display/window/stretch/aspect` has no effect. Recommended for non-game applications. -\ **"canvas_items"**: The base size specified in width and height in the project settings is stretched to cover the whole screen (taking :ref:`display/window/stretch/aspect` into account). This means that everything is rendered directly at the target resolution. 3D is unaffected, while in 2D, there is no longer a 1:1 correspondence between sprite pixels and screen pixels, which may result in scaling artifacts. Recommended for most games that don't use a pixel art aesthetic, although it is possible to use this stretch mode for pixel art games too (especially in 3D). +\ ``"canvas_items"``: The base size specified in width and height in the project settings is stretched to cover the whole screen (taking :ref:`display/window/stretch/aspect` into account). This means that everything is rendered directly at the target resolution. 3D is unaffected, while in 2D, there is no longer a 1:1 correspondence between sprite pixels and screen pixels, which may result in scaling artifacts. Recommended for most games that don't use a pixel art aesthetic, although it is possible to use this stretch mode for pixel art games too (especially in 3D). -\ **"viewport"**: The size of the root :ref:`Viewport` is set precisely to the base size specified in the Project Settings' Display section. The scene is rendered to this viewport first. Finally, this viewport is scaled to fit the screen (taking :ref:`display/window/stretch/aspect` into account). Recommended for games that use a pixel art aesthetic. +\ ``"viewport"``: The size of the root :ref:`Viewport` is set precisely to the base size specified in the Project Settings' Display section. The scene is rendered to this viewport first. Finally, this viewport is scaled to fit the screen (taking :ref:`display/window/stretch/aspect` into account). Recommended for games that use a pixel art aesthetic. .. rst-class:: classref-item-separator @@ -5018,9 +5024,9 @@ The scale factor multiplier to use for 2D elements. This multiplies the final sc The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`display/window/stretch/scale` is applied, in addition to the automatic scale factor determined by :ref:`display/window/stretch/mode`. -\ **"fractional"**: The scale factor will not be modified. +\ ``"fractional"``: The scale factor will not be modified. -\ **"integer"**: The scale factor will be floored to an integer value, which means that the screen size will always be an integer multiple of the base viewport size. This provides a crisp pixel art appearance. +\ ``"integer"``: The scale factor will be floored to an integer value, which means that the screen size will always be an integer multiple of the base viewport size. This provides a crisp pixel art appearance. \ **Note:** When using integer scaling with a stretch mode, resizing the window to be smaller than the base viewport size will clip the contents. Consider preventing that by setting :ref:`Window.min_size` to the same value as the base viewport size defined in :ref:`display/window/size/viewport_width` and :ref:`display/window/size/viewport_height`. @@ -5578,13 +5584,15 @@ If ``true``, snaps :ref:`Control` node vertices to the nearest pi :ref:`int` **gui/common/swap_cancel_ok** = ``0`` :ref:`🔗` -How to position the Cancel and OK buttons in the project's :ref:`AcceptDialog`\ s. Different platforms have different standard behaviors for this, which can be overridden using this setting. +How to position the Cancel and OK buttons in the project's :ref:`AcceptDialog` windows. Different platforms have different conventions for this, which can be overridden through this setting. -- **Auto** (``0``) follows the platform convention: OK first on Windows, KDE, and LXQt, Cancel first on macOS and other Linux desktop environments. :ref:`DisplayServer.get_swap_cancel_ok()` can be used to query whether buttons are swapped at run-time. +- **Auto** follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments. -- **Cancel First** (``1``) forces the ordering Cancel/OK. +- **Cancel First** forces the Cancel/OK ordering. -- **OK First** (``2``) forces the ordering OK/Cancel. +- **OK First** forces the OK/Cancel ordering. + +To check if these buttons are swapped at runtime, use :ref:`DisplayServer.get_swap_cancel_ok()`. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`DisplayServer.dialog_show()`. @@ -5610,7 +5618,7 @@ Maximum undo/redo history size for :ref:`TextEdit` fields. :ref:`bool` **gui/fonts/dynamic_fonts/use_oversampling** = ``true`` :ref:`🔗` -If set to ``true`` and :ref:`display/window/stretch/mode` is set to **"canvas_items"**, font and :ref:`DPITexture` oversampling is enabled in the main window. Use :ref:`Viewport.oversampling` to control oversampling in other viewports and windows. +If set to ``true`` and :ref:`display/window/stretch/mode` is set to ``"canvas_items"``, font and :ref:`DPITexture` oversampling is enabled in the main window. Use :ref:`Viewport.oversampling` to control oversampling in other viewports and windows. .. rst-class:: classref-item-separator @@ -10318,7 +10326,7 @@ Maximum size (in kiB) for the :ref:`WebRTCDataChannel` :ref:`String` **network/tls/certificate_bundle_override** = ``""`` :ref:`🔗` -The CA certificates bundle to use for TLS connections. If this is set to a non-empty value, this will *override* Godot's default `Mozilla certificate bundle `__. If left empty, the default certificate bundle will be used. +The CA certificates bundle to use for TLS connections. If this is set to a non-empty value, this will *override* Godot's default `Mozilla certificate bundle `__. If left empty, the default certificate bundle will be used. If in doubt, leave this setting empty. @@ -12902,7 +12910,7 @@ Lower-end override for :ref:`rendering/reflections/sky_reflections/ggx_samples` **rendering/reflections/sky_reflections/roughness_layers** = ``8`` :ref:`🔗` +:ref:`int` **rendering/reflections/sky_reflections/roughness_layers** = ``7`` :ref:`🔗` Limits the number of layers to use in radiance maps when using importance sampling. A lower number will be slightly faster and take up less VRAM. @@ -13006,13 +13014,13 @@ Version code of the `Direct3D 12 Agility SDK ` **rendering/rendering_device/d3d12/max_misc_descriptors_per_frame** = ``512`` :ref:`🔗` +:ref:`int` **rendering/rendering_device/d3d12/max_resource_descriptors** = ``65536`` :ref:`🔗` -The number of entries in the miscellaneous descriptors heap the Direct3D 12 rendering driver uses each frame, used for various operations like clearing a texture. +The number of entries in the resource descriptor heap the Direct3D 12 rendering driver uses for most rendering operations. Depending on the complexity of scenes, this value may be lowered or may need to be raised. @@ -13020,27 +13028,13 @@ Depending on the complexity of scenes, this value may be lowered or may need to ---- -.. _class_ProjectSettings_property_rendering/rendering_device/d3d12/max_resource_descriptors_per_frame: +.. _class_ProjectSettings_property_rendering/rendering_device/d3d12/max_sampler_descriptors: .. rst-class:: classref-property -:ref:`int` **rendering/rendering_device/d3d12/max_resource_descriptors_per_frame** = ``16384`` :ref:`🔗` +:ref:`int` **rendering/rendering_device/d3d12/max_sampler_descriptors** = ``1024`` :ref:`🔗` -The number of entries in the resource descriptors heap the Direct3D 12 rendering driver uses each frame, used for most rendering operations. - -Depending on the complexity of scenes, this value may be lowered or may need to be raised. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame: - -.. rst-class:: classref-property - -:ref:`int` **rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame** = ``1024`` :ref:`🔗` - -The number of entries in the sampler descriptors heap the Direct3D 12 rendering driver uses each frame, used for most rendering operations. +The number of entries in the sampler descriptor heap the Direct3D 12 rendering driver uses for most rendering operations. Depending on the complexity of scenes, this value may be lowered or may need to be raised. @@ -13178,6 +13172,8 @@ Two options are supported: - ``d3d12``, Direct3D 12 from native drivers. If :ref:`rendering/rendering_device/fallback_to_d3d12` is enabled, this is used as a fallback if Vulkan is not supported. +\ **Note:** Starting with Godot 4.6, new projects are configured by default to use ``d3d12`` on Windows. Projects created before Godot 4.6 keep ``vulkan`` for compatibility reasons, but it is recommended to switch them manually to ``d3d12``. + .. rst-class:: classref-item-separator ---- @@ -13188,7 +13184,7 @@ Two options are supported: :ref:`bool` **rendering/rendering_device/fallback_to_d3d12** = ``true`` :ref:`🔗` -If ``true``, the forward renderer will fall back to Direct3D 12 if Vulkan is not supported. The fallback is always attempted regardless of this setting if Vulkan driver support was disabled at compile time. +If ``true``, the Forward+ renderer will fall back to Direct3D 12 if Vulkan is not supported. The fallback is always attempted regardless of this setting if Vulkan driver support was disabled at compile time. \ **Note:** This setting is implemented only on Windows. @@ -13202,7 +13198,7 @@ If ``true``, the forward renderer will fall back to Direct3D 12 if Vulkan is not :ref:`bool` **rendering/rendering_device/fallback_to_opengl3** = ``true`` :ref:`🔗` -If ``true``, the forward renderer will fall back to OpenGL 3 if Direct3D 12, Metal, and Vulkan are not supported. +If ``true``, the Forward+ renderer will fall back to OpenGL 3 if Direct3D 12, Metal, and Vulkan are not supported. \ **Note:** This setting is implemented on Windows, Android, macOS, iOS, and Linux/X11. @@ -13216,7 +13212,7 @@ If ``true``, the forward renderer will fall back to OpenGL 3 if Direct3D 12, Met :ref:`bool` **rendering/rendering_device/fallback_to_vulkan** = ``true`` :ref:`🔗` -If ``true``, the forward renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. The fallback is always attempted regardless of this setting if Direct3D 12 (Windows) or Metal (macOS) driver support was disabled at compile time. +If ``true``, the Forward+ renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. The fallback is always attempted regardless of this setting if Direct3D 12 (Windows) or Metal (macOS) driver support was disabled at compile time. \ **Note:** This setting is implemented on Windows and macOS. @@ -13688,7 +13684,7 @@ If ``true``, the texture importer will import lossless textures using the PNG fo :ref:`bool` **rendering/textures/vram_compression/cache_gpu_compressor** = ``true`` :ref:`🔗` -If ``true``, the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), allowing for faster subsequent imports at a memory cost. +If ``true``, the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), making subsequent imports faster at the cost of increased memory usage. .. rst-class:: classref-item-separator @@ -13772,9 +13768,7 @@ The default compression factor for lossless WebP. Decompression speed is mostly :ref:`bool` **rendering/viewport/hdr_2d** = ``false`` :ref:`🔗` -If ``true``, enables :ref:`Viewport.use_hdr_2d` on the root viewport. 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility renderer, this will be an ``RGBA16`` framebuffer. When using the Mobile renderer, it will be an ``RGB10_A2`` framebuffer. - -Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen). +If ``true``, enables :ref:`Viewport.use_hdr_2d` on the root Viewport. 2D rendering will use a high dynamic range (HDR) ``RGBA16`` format framebuffer. Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen. Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color encoding adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. @@ -13853,7 +13847,7 @@ The ratio of :ref:`WorkerThreadPool`'s threads that will :ref:`int` **threading/worker_pool/max_threads** = ``-1`` :ref:`🔗` -Maximum number of threads to be used by :ref:`WorkerThreadPool`. Value of ``-1`` means ``1`` on Web, or a number of *logical* CPU cores available on other platforms (see :ref:`OS.get_processor_count()`). +Maximum number of threads to be used by :ref:`WorkerThreadPool`. On Web, a value of ``-1`` means ``1``. On other platforms, it means all *logical* CPU cores available (see :ref:`OS.get_processor_count()`). .. rst-class:: classref-item-separator @@ -14203,7 +14197,7 @@ If ``true`` and foveation is supported, will automatically adjust foveation leve :ref:`int` **xr/openxr/foveation_level** = ``"0"`` :ref:`🔗` -Applied foveation level if supported: 0 = off, 1 = low, 2 = medium, 3 = high. +Applied foveation level if supported. \ **Note:** On platforms other than Android, if :ref:`rendering/anti_aliasing/quality/msaa_3d` is enabled, this feature will be disabled. diff --git a/classes/class_range.rst b/classes/class_range.rst index afbeab2f4..fecedb724 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -260,7 +260,7 @@ If ``true``, :ref:`value` will always be rounded to - |void| **set_step**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_step**\ (\ ) -If greater than 0, :ref:`value` will always be rounded to a multiple of this property's value above :ref:`min_value`. For example, if :ref:`min_value` is ``0.1`` and step is 0.2, then :ref:`value` is limited to ``0.1``, ``0.3``, ``0.5``, and so on. If :ref:`rounded` is also ``true``, :ref:`value` will first be rounded to a multiple of this property's value, then rounded to the nearest integer. +If greater than ``0.0``, :ref:`value` will always be rounded to a multiple of this property's value above :ref:`min_value`. For example, if :ref:`min_value` is ``0.1`` and step is ``0.2``, then :ref:`value` is limited to ``0.1``, ``0.3``, ``0.5``, and so on. If :ref:`rounded` is also ``true``, :ref:`value` will first be rounded to a multiple of this property's value, then rounded to the nearest integer. .. rst-class:: classref-item-separator diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 91f3ae4bb..7ec3413d2 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -396,7 +396,7 @@ Returns whether any object is intersecting with the ray's vector (considering th |void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) :ref:`🔗` -Removes a collision exception so the ray can report collisions with the specified specified ``node``. +Removes a collision exception so the ray can report collisions with the specified ``node``. .. rst-class:: classref-item-separator diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index cd7eb4d0f..7a603ca79 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -397,6 +397,8 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_tonemap`\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_tonemap_agx_contrast`\ (\ env\: :ref:`RID`, agx_contrast\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_volumetric_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_volumetric_fog_filter_active`\ (\ active\: :ref:`bool`\ ) | @@ -4316,9 +4318,7 @@ Uses a high-contrast film-like tonemapping curve and desaturates bright values f :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_AGX** = ``4`` -Uses a film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. - -\ **Note:** :ref:`Environment.tonemap_white` is fixed at a value of ``16.29``, which makes :ref:`ENV_TONE_MAPPER_AGX` unsuitable for use with the Mobile rendering method. +Uses an adjustable film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. .. rst-class:: classref-item-separator @@ -8290,6 +8290,18 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` ---- +.. _class_RenderingServer_method_environment_set_tonemap_agx_contrast: + +.. rst-class:: classref-method + +|void| **environment_set_tonemap_agx_contrast**\ (\ env\: :ref:`RID`, agx_contrast\: :ref:`float`\ ) :ref:`🔗` + +See :ref:`Environment.tonemap_agx_contrast` for more details. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_environment_set_volumetric_fog: .. rst-class:: classref-method @@ -11858,7 +11870,7 @@ Updates the texture specified by the ``texture`` :ref:`RID`'s data wi Creates a texture based on a native handle that was created outside of Godot's renderer. -\ **Note:** If using only the rendering device renderer, it's recommend to use :ref:`RenderingDevice.texture_create_from_extension()` together with :ref:`texture_rd_create()`, rather than this method. It will give you much more control over the texture's format and usage. +\ **Note:** If using only the rendering device renderer, it's recommend to use :ref:`RenderingDevice.texture_create_from_extension()` together with :ref:`texture_rd_create()`, rather than this method. This way, the texture's format and usage can be controlled more effectively. .. rst-class:: classref-item-separator @@ -12635,9 +12647,7 @@ Equivalent to :ref:`Viewport.use_debanding`, enabled\: :ref:`bool`\ ) :ref:`🔗` -If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility renderer, this will be an ``RGBA16`` framebuffer. When using the Mobile renderer, it will be an ``RGB10_A2`` framebuffer. - -Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen). +If ``true``, 2D rendering will use a high dynamic range (HDR) ``RGBA16`` format framebuffer. Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color encoding adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index aa7cacc15..ef0a65274 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -357,9 +357,7 @@ The following exceptions apply: :ref:`Resource` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`DeepDuplicateMode` = 1\ ) |const| :ref:`🔗` -Duplicates this resource, deeply, like :ref:`duplicate()`\ ``(true)``, with extra control over how subresources are handled. - -\ ``deep_subresources_mode`` must be one of the values from :ref:`DeepDuplicateMode`. +Duplicates this resource, deeply, like :ref:`duplicate()` when passing ``true``, with extra control over how subresources are handled. .. rst-class:: classref-item-separator diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 2732a4b2e..4f4806c2e 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -195,7 +195,7 @@ The hinting mode to use. This controls how aggressively glyph edges should be sn \ **Light:** Sharp result by snapping glyph edges to pixels on the Y axis only. -\ **Full:** Sharpest by snapping glyph edges to pixels on both X and Y axes. +\ **Normal:** Sharpest by snapping glyph edges to pixels on both X and Y axes. .. rst-class:: classref-item-separator diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst index d4a187e7a..2d107b9a4 100644 --- a/classes/class_resourceimportermp3.rst +++ b/classes/class_resourceimportermp3.rst @@ -3,7 +3,7 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/ResourceImporterMP3.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/mp3/doc_classes/ResourceImporterMP3.xml. .. _class_ResourceImporterMP3: diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index e7858801f..1dba39ba5 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -131,7 +131,7 @@ Like :ref:`create_id()`, but the UID is seed :ref:`String` **ensure_path**\ (\ path_or_uid\: :ref:`String`\ ) |static| :ref:`🔗` -Returns a path, converting ``path_or_uid`` if necessary. Prints an error if provided an invalid UID. +Returns a path, converting ``path_or_uid`` if necessary. Fails and returns an empty string if an invalid UID is provided. .. rst-class:: classref-item-separator diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 8e119829a..094c892a4 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -794,7 +794,7 @@ If ``true``, the label underlines hint tags such as ``[hint=description]{text}[/ - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. +Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). .. rst-class:: classref-item-separator @@ -828,7 +828,7 @@ Line fill alignment rules. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator @@ -2082,7 +2082,7 @@ Adds a ``[p]`` tag to the tag stack. |void| **push_strikethrough**\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) :ref:`🔗` -Adds a ``[s]`` tag to the tag stack. If ``color`` alpha value is zero, current font color with alpha multiplied by :ref:`strikethrough_alpha` is used. +Adds a ``[s]`` tag to the tag stack. If ``color``'s alpha value is ``0.0``, the current font's color with its alpha multiplied by :ref:`strikethrough_alpha` is used. .. rst-class:: classref-item-separator @@ -2106,7 +2106,7 @@ Adds a ``[table=columns,inline_align]`` tag to the tag stack. Use :ref:`set_tabl |void| **push_underline**\ (\ color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) :ref:`🔗` -Adds a ``[u]`` tag to the tag stack. If ``color`` alpha value is zero, current font color with alpha multiplied by :ref:`underline_alpha` is used. +Adds a ``[u]`` tag to the tag stack. If ``color``'s alpha value is ``0.0``, the current font's color with its alpha multiplied by :ref:`underline_alpha` is used. .. rst-class:: classref-item-separator diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index a700d26bf..e958bcea4 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -567,7 +567,7 @@ If ``true``, the body is frozen. Gravity and forces are not applied anymore. See :ref:`freeze_mode` to set the body's behavior when frozen. -For a body that is always frozen, use :ref:`StaticBody2D` or :ref:`AnimatableBody2D` instead. +\ **Note:** For a body that is always frozen, use :ref:`StaticBody2D` or :ref:`AnimatableBody2D` instead. .. rst-class:: classref-item-separator @@ -584,9 +584,9 @@ For a body that is always frozen, use :ref:`StaticBody2D` or - |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) - :ref:`FreezeMode` **get_freeze_mode**\ (\ ) -The body's freeze mode. Can be used to set the body's behavior when :ref:`freeze` is enabled. +The body's freeze mode. Determines the body's behavior when :ref:`freeze` is ``true``. -For a body that is always frozen, use :ref:`StaticBody2D` or :ref:`AnimatableBody2D` instead. +\ **Note:** For a body that is always frozen, use :ref:`StaticBody2D` or :ref:`AnimatableBody2D` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index 44652bbc9..7c34f45b0 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -535,7 +535,7 @@ If ``true``, the body is frozen. Gravity and forces are not applied anymore. See :ref:`freeze_mode` to set the body's behavior when frozen. -For a body that is always frozen, use :ref:`StaticBody3D` or :ref:`AnimatableBody3D` instead. +\ **Note:** For a body that is always frozen, use :ref:`StaticBody3D` or :ref:`AnimatableBody3D` instead. .. rst-class:: classref-item-separator @@ -552,9 +552,9 @@ For a body that is always frozen, use :ref:`StaticBody3D` or - |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) - :ref:`FreezeMode` **get_freeze_mode**\ (\ ) -The body's freeze mode. Can be used to set the body's behavior when :ref:`freeze` is enabled. +The body's freeze mode. Determines the body's behavior when :ref:`freeze` is ``true``. -For a body that is always frozen, use :ref:`StaticBody3D` or :ref:`AnimatableBody3D` instead. +\ **Note:** For a body that is always frozen, use :ref:`StaticBody3D` or :ref:`AnimatableBody3D` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_script.rst b/classes/class_script.rst index 0c2274a89..d094b29ef 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -258,7 +258,7 @@ Returns the list of properties in this **Script**. :ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) :ref:`🔗` -Returns the list of user signals defined in this **Script**. +Returns the list of signals defined in this **Script**. \ **Note:** The dictionaries returned by this method are formatted identically to those returned by :ref:`Object.get_signal_list()`. diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 8eff5960e..dcb8bc9d8 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -38,27 +38,31 @@ Properties .. table:: :widths: auto - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`draw_focus_border` | ``false`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`follow_focus` | ``false`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`ScrollMode` | :ref:`horizontal_scroll_mode` | ``1`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`scroll_deadzone` | ``0`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`scroll_horizontal` | ``0`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`float` | :ref:`scroll_horizontal_custom_step` | ``-1.0`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`scroll_vertical` | ``0`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`float` | :ref:`scroll_vertical_custom_step` | ``-1.0`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`ScrollMode` | :ref:`vertical_scroll_mode` | ``1`` | - +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_focus_border` | ``false`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`follow_focus` | ``false`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`ScrollMode` | :ref:`horizontal_scroll_mode` | ``1`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`scroll_deadzone` | ``0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`ScrollHintMode` | :ref:`scroll_hint_mode` | ``0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`scroll_horizontal` | ``0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scroll_horizontal_custom_step` | ``-1.0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`scroll_vertical` | ``0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scroll_vertical_custom_step` | ``-1.0`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tile_scroll_hint` | ``false`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`ScrollMode` | :ref:`vertical_scroll_mode` | ``1`` | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -84,15 +88,19 @@ Theme Properties .. table:: :widths: auto - +---------------------------------+--------------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`scrollbar_h_separation` | ``0`` | - +---------------------------------+--------------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`scrollbar_v_separation` | ``0`` | - +---------------------------------+--------------------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`focus` | | - +---------------------------------+--------------------------------------------------------------------------------------------+-------+ - | :ref:`StyleBox` | :ref:`panel` | | - +---------------------------------+--------------------------------------------------------------------------------------------+-------+ + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`scrollbar_h_separation` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`scrollbar_v_separation` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`scroll_hint_horizontal` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`Texture2D` | :ref:`scroll_hint_vertical` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ + | :ref:`StyleBox` | :ref:`panel` | | + +-----------------------------------+--------------------------------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator @@ -182,6 +190,48 @@ Scrolling enabled, scrollbar will be hidden. Combines :ref:`SCROLL_MODE_AUTO` and :ref:`SCROLL_MODE_SHOW_ALWAYS`. The scrollbar is only visible if necessary, but the content size is adjusted as if it was always visible. It's useful for ensuring that content size stays the same regardless if the scrollbar is visible. +.. rst-class:: classref-item-separator + +---- + +.. _enum_ScrollContainer_ScrollHintMode: + +.. rst-class:: classref-enumeration + +enum **ScrollHintMode**: :ref:`🔗` + +.. _class_ScrollContainer_constant_SCROLL_HINT_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_DISABLED** = ``0`` + +Scroll hints will never be shown. + +.. _class_ScrollContainer_constant_SCROLL_HINT_MODE_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_ALL** = ``1`` + +Scroll hints will be shown at the top and bottom (if vertical), or left and right (if horizontal). + +.. _class_ScrollContainer_constant_SCROLL_HINT_MODE_TOP_AND_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_TOP_AND_LEFT** = ``2`` + +Scroll hints will be shown at the top (if vertical), or the left (if horizontal). + +.. _class_ScrollContainer_constant_SCROLL_HINT_MODE_BOTTOM_AND_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_BOTTOM_AND_RIGHT** = ``3`` + +Scroll hints will be shown at the bottom (if horizontal), or the right (if horizontal). + .. rst-class:: classref-section-separator ---- @@ -259,6 +309,25 @@ Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. ---- +.. _class_ScrollContainer_property_scroll_hint_mode: + +.. rst-class:: classref-property + +:ref:`ScrollHintMode` **scroll_hint_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_scroll_hint_mode**\ (\ value\: :ref:`ScrollHintMode`\ ) +- :ref:`ScrollHintMode` **get_scroll_hint_mode**\ (\ ) + +The way which scroll hints (indicators that show that the content can still be scrolled in a certain direction) will be shown. + +\ **Note:** Hints won't be shown if the content can be scrolled both vertically and horizontally. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScrollContainer_property_scroll_horizontal: .. rst-class:: classref-property @@ -341,6 +410,23 @@ Overrides the :ref:`ScrollBar.custom_step` ---- +.. _class_ScrollContainer_property_tile_scroll_hint: + +.. rst-class:: classref-property + +:ref:`bool` **tile_scroll_hint** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tile_scroll_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_hint_tiled**\ (\ ) + +If ``true``, the scroll hint texture will be tiled instead of stretched. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScrollContainer_property_vertical_scroll_mode: .. rst-class:: classref-property @@ -440,6 +526,30 @@ The space between the ScrollContainer's horizontal scroll bar and its content, i ---- +.. _class_ScrollContainer_theme_icon_scroll_hint_horizontal: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **scroll_hint_horizontal** :ref:`🔗` + +The indicator that will be shown when the content can still be scrolled horizontally. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ScrollContainer_theme_icon_scroll_hint_vertical: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **scroll_hint_vertical** :ref:`🔗` + +The indicator that will be shown when the content can still be scrolled vertically. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScrollContainer_theme_style_focus: .. rst-class:: classref-themeproperty diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 3aacfcb18..e2554bb04 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -571,7 +571,7 @@ Returns the global rest transform for ``bone_idx``. :ref:`Variant` **get_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`\ ) |const| :ref:`🔗` -Returns the metadata for the bone at index ``bone_idx`` with ``key``. +Returns the metadata with the given ``key`` for the bone at index ``bone_idx``. .. rst-class:: classref-item-separator @@ -725,7 +725,7 @@ Use for invalidating caches in IK solvers and other nodes which process bones. :ref:`bool` **has_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`\ ) |const| :ref:`🔗` -Returns ``true`` if the bone at index ``bone_idx`` has metadata with the key ``key``. +Returns ``true`` if the bone at index ``bone_idx`` has metadata with the given ``key``. .. rst-class:: classref-item-separator @@ -903,7 +903,7 @@ Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. |void| **set_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` -Sets the metadata for the bone at index ``bone_idx``, setting the ``key`` meta to ``value``. +Sets the metadata with the given ``key`` to ``value`` for the bone at index ``bone_idx``. .. rst-class:: classref-item-separator diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index db97acb87..c20f8e8a1 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -12,7 +12,7 @@ SkeletonModifier3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BoneConstraint3D`, :ref:`IKModifier3D`, :ref:`LimitAngularVelocityModifier3D`, :ref:`LookAtModifier3D`, :ref:`ModifierBoneTarget3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` +**Inherited By:** :ref:`BoneConstraint3D`, :ref:`BoneTwistDisperser3D`, :ref:`IKModifier3D`, :ref:`LimitAngularVelocityModifier3D`, :ref:`LookAtModifier3D`, :ref:`ModifierBoneTarget3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` A node that may modify a Skeleton3D's bones. @@ -440,7 +440,7 @@ Called when the skeleton is changed. |void| **_validate_bone_names**\ (\ ) |virtual| :ref:`🔗` -Called when bone name and index need to be validated such as the timing of the entering tree or changing skeleton. +Called when bone names and indices need to be validated, such as when entering the scene tree or changing skeleton. .. rst-class:: classref-item-separator @@ -452,7 +452,7 @@ Called when bone name and index need to be validated such as the timing of the e :ref:`Skeleton3D` **get_skeleton**\ (\ ) |const| :ref:`🔗` -Get parent :ref:`Skeleton3D` node if found. +Returns the parent :ref:`Skeleton3D` node if it exists. Otherwise, returns ``null``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index ffba1a597..a3ed22830 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -14,14 +14,14 @@ SplitContainer **Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` -A container that splits two child controls horizontally or vertically and provides a grabber for adjusting the split ratio. +A container that arranges child controls horizontally or vertically and provides grabbers for adjusting the split ratios between them. .. rst-class:: classref-introduction-group Description ----------- -A container that accepts only two child controls, then arranges them horizontally or vertically and creates a divisor between them. The divisor can be dragged around to change the size relation between the child controls. +A container that arranges child controls horizontally or vertically and creates grabbers between them. The grabbers can be dragged around to change the size relations between the child controls. .. rst-class:: classref-introduction-group @@ -38,27 +38,29 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`collapsed` | ``false`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`drag_area_highlight_in_editor` | ``false`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`drag_area_margin_begin` | ``0`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`drag_area_margin_end` | ``0`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`drag_area_offset` | ``0`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`DraggerVisibility` | :ref:`dragger_visibility` | ``0`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`dragging_enabled` | ``true`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`split_offset` | ``0`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`touch_dragger_enabled` | ``false`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`vertical` | ``false`` | - +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`collapsed` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`drag_area_highlight_in_editor` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`drag_area_margin_begin` | ``0`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`drag_area_margin_end` | ``0`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`drag_area_offset` | ``0`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`DraggerVisibility` | :ref:`dragger_visibility` | ``0`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`dragging_enabled` | ``true`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`split_offset` | ``0`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`PackedInt32Array` | :ref:`split_offsets` | ``PackedInt32Array(0)`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`touch_dragger_enabled` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`vertical` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group @@ -68,11 +70,13 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------+ - | |void| | :ref:`clamp_split_offset`\ (\ ) | - +-------------------------------+---------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_drag_area_control`\ (\ ) | - +-------------------------------+---------------------------------------------------------------------------------------+ + +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clamp_split_offset`\ (\ priority_index\: :ref:`int` = 0\ ) | + +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_drag_area_control`\ (\ ) | + +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Control`\] | :ref:`get_drag_area_controls`\ (\ ) | + +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -149,7 +153,7 @@ Emitted when the user starts dragging. **dragged**\ (\ offset\: :ref:`int`\ ) :ref:`🔗` -Emitted when the dragger is dragged by user. +Emitted when any dragger is dragged by user. .. rst-class:: classref-section-separator @@ -216,7 +220,7 @@ Property Descriptions - |void| **set_collapsed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_collapsed**\ (\ ) -If ``true``, the dragger will be disabled and the children will be sized as if the :ref:`split_offset` was ``0``. +If ``true``, the draggers will be disabled and the children will be sized as if all :ref:`split_offsets` were ``0``. .. rst-class:: classref-item-separator @@ -335,7 +339,32 @@ Enables or disables split dragging. - |void| **set_split_offset**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_split_offset**\ (\ ) -The initial offset of the splitting between the two :ref:`Control`\ s, with ``0`` being at the end of the first :ref:`Control`. +**Deprecated:** Use :ref:`split_offsets` instead. The first element of the array is the split offset between the first two children. + +The first element of :ref:`split_offsets`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplitContainer_property_split_offsets: + +.. rst-class:: classref-property + +:ref:`PackedInt32Array` **split_offsets** = ``PackedInt32Array(0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_split_offsets**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_split_offsets**\ (\ ) + +Offsets for each dragger in pixels. Each one is the offset of the split between the :ref:`Control` nodes before and after the dragger, with ``0`` being the default position. The default position is based on the :ref:`Control` nodes expand flags and minimum sizes. See :ref:`Control.size_flags_horizontal`, :ref:`Control.size_flags_vertical`, and :ref:`Control.size_flags_stretch_ratio`. + +If none of the :ref:`Control` nodes before the dragger are expanded, the default position will be at the start of the **SplitContainer**. If none of the :ref:`Control` nodes after the dragger are expanded, the default position will be at the end of the **SplitContainer**. If the dragger is in between expanded :ref:`Control` nodes, the default position will be in the middle, based on the :ref:`Control.size_flags_stretch_ratio`\ s and minimum sizes. + +\ **Note:** If the split offsets cause :ref:`Control` nodes to overlap, the first split will take priority when resolving the positions. + +**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. .. rst-class:: classref-item-separator @@ -386,9 +415,9 @@ Method Descriptions .. rst-class:: classref-method -|void| **clamp_split_offset**\ (\ ) :ref:`🔗` +|void| **clamp_split_offset**\ (\ priority_index\: :ref:`int` = 0\ ) :ref:`🔗` -Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. +Clamps the :ref:`split_offsets` values to ensure they are within valid ranges and do not overlap with each other. When overlaps occur, this method prioritizes one split offset (at index ``priority_index``) by clamping any overlapping split offsets to it. .. rst-class:: classref-item-separator @@ -400,6 +429,8 @@ Clamps the :ref:`split_offset` value :ref:`Control` **get_drag_area_control**\ (\ ) :ref:`🔗` +**Deprecated:** Use the first element of :ref:`get_drag_area_controls()` instead. + Returns the drag area :ref:`Control`. For example, you can move a pre-configured button into the drag area :ref:`Control` so that it rides along with the split bar. Try setting the :ref:`Button` anchors to ``center`` prior to the ``reparent()`` call. :: @@ -410,6 +441,26 @@ Returns the drag area :ref:`Control`. For example, you can move a \ **Warning:** This is a required internal node, removing and freeing it may cause a crash. +.. rst-class:: classref-item-separator + +---- + +.. _class_SplitContainer_method_get_drag_area_controls: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Control`\] **get_drag_area_controls**\ (\ ) :ref:`🔗` + +Returns an :ref:`Array` of the drag area :ref:`Control`\ s. These are the interactable :ref:`Control` nodes between each child. For example, this can be used to add a pre-configured button to a drag area :ref:`Control` so that it rides along with the split bar. Try setting the :ref:`Button` anchors to ``center`` prior to the :ref:`Node.reparent()` call. + +:: + + $BarnacleButton.reparent($SplitContainer.get_drag_area_controls()[0]) + +\ **Note:** The drag area :ref:`Control`\ s are drawn over the **SplitContainer**'s children, so :ref:`CanvasItem` draw objects called from a drag area and children added to it will also appear over the **SplitContainer**'s children. Try setting :ref:`Control.mouse_filter` of custom children to :ref:`Control.MOUSE_FILTER_IGNORE` to prevent blocking the mouse from dragging if desired. + +\ **Warning:** These are required internal nodes, removing or freeing them may cause a crash. + .. rst-class:: classref-section-separator ---- @@ -461,7 +512,7 @@ The color of the touch dragger when pressed. :ref:`int` **autohide** = ``1`` :ref:`🔗` -Boolean value. If ``1`` (``true``), the grabber will hide automatically when it isn't under the cursor. If ``0`` (``false``), it's always visible. The :ref:`dragger_visibility` must be :ref:`DRAGGER_VISIBLE`. +Boolean value. If ``1`` (``true``), the grabbers will hide automatically when they aren't under the cursor. If ``0`` (``false``), the grabbers are always visible. The :ref:`dragger_visibility` must be :ref:`DRAGGER_VISIBLE`. .. rst-class:: classref-item-separator @@ -473,7 +524,7 @@ Boolean value. If ``1`` (``true``), the grabber will hide automatically when it :ref:`int` **minimum_grab_thickness** = ``6`` :ref:`🔗` -The minimum thickness of the area users can click on to grab the split bar. This ensures that the split bar can still be dragged if :ref:`separation` or :ref:`h_grabber` / :ref:`v_grabber`'s size is too narrow to easily select. +The minimum thickness of the area users can click on to grab a split bar. This ensures that the split bar can still be dragged if :ref:`separation` or :ref:`h_grabber` / :ref:`v_grabber`'s size is too narrow to easily select. .. rst-class:: classref-item-separator @@ -485,7 +536,7 @@ The minimum thickness of the area users can click on to grab the split bar. This :ref:`int` **separation** = ``12`` :ref:`🔗` -The split bar thickness, i.e., the gap between the two children of the container. This is overridden by the size of the grabber icon if :ref:`dragger_visibility` is set to :ref:`DRAGGER_VISIBLE`, or :ref:`DRAGGER_HIDDEN`, and :ref:`separation` is smaller than the size of the grabber icon in the same axis. +The split bar thickness, i.e., the gap between each child of the container. This is overridden by the size of the grabber icon if :ref:`dragger_visibility` is set to :ref:`DRAGGER_VISIBLE`, or :ref:`DRAGGER_HIDDEN`, and :ref:`separation` is smaller than the size of the grabber icon in the same axis. \ **Note:** To obtain :ref:`separation` values less than the size of the grabber icon, for example a ``1 px`` hairline, set :ref:`h_grabber` or :ref:`v_grabber` to a new :ref:`ImageTexture`, which effectively sets the grabber icon size to ``0 px``. @@ -499,7 +550,7 @@ The split bar thickness, i.e., the gap between the two children of the container :ref:`Texture2D` **grabber** :ref:`🔗` -The icon used for the grabber drawn in the middle area. This is only used in :ref:`HSplitContainer` and :ref:`VSplitContainer`. For **SplitContainer**, see :ref:`h_grabber` and :ref:`v_grabber` instead. +The icon used for the grabbers drawn in the separations. This is only used in :ref:`HSplitContainer` and :ref:`VSplitContainer`. For **SplitContainer**, see :ref:`h_grabber` and :ref:`v_grabber` instead. .. rst-class:: classref-item-separator @@ -511,7 +562,7 @@ The icon used for the grabber drawn in the middle area. This is only used in :re :ref:`Texture2D` **h_grabber** :ref:`🔗` -The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``false``. +The icon used for the grabbers drawn in the separations when :ref:`vertical` is ``false``. .. rst-class:: classref-item-separator @@ -547,7 +598,7 @@ The icon used for the drag handle when :ref:`touch_dragger_enabled` **v_grabber** :ref:`🔗` -The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``true``. +The icon used for the grabbers drawn in the separations when :ref:`vertical` is ``true``. .. rst-class:: classref-item-separator diff --git a/classes/class_springarm3d.rst b/classes/class_springarm3d.rst index 7bbf0d1cb..a171f8473 100644 --- a/classes/class_springarm3d.rst +++ b/classes/class_springarm3d.rst @@ -84,7 +84,7 @@ Property Descriptions - |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_collision_mask**\ (\ ) -The layers against which the collision check shall be done. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. +The layers against which the collision check will be done. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. .. rst-class:: classref-item-separator diff --git a/classes/class_sprite2d.rst b/classes/class_sprite2d.rst index 507ebe78b..f45ff61dd 100644 --- a/classes/class_sprite2d.rst +++ b/classes/class_sprite2d.rst @@ -377,9 +377,7 @@ Returns a :ref:`Rect2` representing the Sprite2D's boundary in loca :ref:`bool` **is_pixel_opaque**\ (\ pos\: :ref:`Vector2`\ ) |const| :ref:`🔗` -Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. The position is in local coordinates. - -\ **Note:** It also returns ``false``, if the sprite's texture is ``null`` or if the given position is invalid. +Returns ``true`` if the pixel at the given position is opaque, ``false`` otherwise. Also returns ``false`` if the given position is out of bounds or this sprite's :ref:`texture` is ``null``. ``pos`` is in local coordinates. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 34822e39e..80731242f 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -210,7 +210,7 @@ Returns the number of bytes this **StreamPeer** has available. :ref:`Array` **get_data**\ (\ bytes\: :ref:`int`\ ) :ref:`🔗` -Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the ``bytes`` argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an :ref:`Error` code and a data array. +Returns a chunk data with the received bytes, as an :ref:`Array` containing two elements: an :ref:`Error` constant and a :ref:`PackedByteArray`. ``bytes`` is the number of bytes to be received. If not enough bytes are available, the function will block until the desired amount is received. .. rst-class:: classref-item-separator @@ -258,7 +258,7 @@ Gets a half-precision float from the stream. :ref:`Array` **get_partial_data**\ (\ bytes\: :ref:`int`\ ) :ref:`🔗` -Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the ``bytes`` argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values: an :ref:`Error` code and a data array. +Returns a chunk data with the received bytes, as an :ref:`Array` containing two elements: an :ref:`Error` constant and a :ref:`PackedByteArray`. ``bytes`` is the number of bytes to be received. If not enough bytes are available, the function will return how many were actually received. .. rst-class:: classref-item-separator diff --git a/classes/class_string.rst b/classes/class_string.rst index 5dcb9e0c5..5abb72767 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1588,7 +1588,7 @@ Removes all occurrences of the Unicode character with code ``what``. Faster vers :ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` -Removes any occurrence of the characters in ``chars``. See also :ref:`remove_char()`. +Removes all occurrences of the characters in ``chars``. See also :ref:`remove_char()`. .. rst-class:: classref-item-separator diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index c2a0bf24b..6e5a81207 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -1422,7 +1422,7 @@ Removes all occurrences of the Unicode character with code ``what``. Faster vers :ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` -Removes any occurrence of the characters in ``chars``. See also :ref:`remove_char()`. +Removes all occurrences of the characters in ``chars``. See also :ref:`remove_char()`. .. rst-class:: classref-item-separator diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index ef8345170..29c4b00ee 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -268,9 +268,9 @@ Emitted when a tab is clicked, even if it is the current tab. **tab_close_pressed**\ (\ tab\: :ref:`int`\ ) :ref:`🔗` -Emitted when a tab's close button is pressed or when middle-clicking on a tab, if :ref:`close_with_middle_mouse` is enabled. +Emitted when a tab's close button is pressed or, if :ref:`close_with_middle_mouse` is ``true``, when middle-clicking on a tab. -\ **Note:** Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example: +\ **Note:** Tabs are not removed automatically; this behavior needs to be coded manually. For example: .. tabs:: @@ -342,7 +342,7 @@ enum **AlignmentMode**: :ref:`🔗` :ref:`AlignmentMode` **ALIGNMENT_LEFT** = ``0`` -Places tabs to the left. +Aligns tabs to the left. .. _class_TabBar_constant_ALIGNMENT_CENTER: @@ -350,7 +350,7 @@ Places tabs to the left. :ref:`AlignmentMode` **ALIGNMENT_CENTER** = ``1`` -Places tabs in the middle. +Aligns tabs in the middle. .. _class_TabBar_constant_ALIGNMENT_RIGHT: @@ -358,7 +358,7 @@ Places tabs in the middle. :ref:`AlignmentMode` **ALIGNMENT_RIGHT** = ``2`` -Places tabs to the right. +Aligns tabs to the right. .. _class_TabBar_constant_ALIGNMENT_MAX: @@ -447,7 +447,7 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n - |void| **set_close_with_middle_mouse**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_close_with_middle_mouse**\ (\ ) -If ``true``, middle clicking on the mouse will fire the :ref:`tab_close_pressed` signal. +If ``true``, middle-clicking on a tab will emit the :ref:`tab_close_pressed` signal. .. rst-class:: classref-item-separator @@ -600,7 +600,7 @@ If ``true``, hovering over a tab while dragging something will switch to that ta - |void| **set_tab_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) - :ref:`AlignmentMode` **get_tab_alignment**\ (\ ) -The position at which tabs will be placed. +The horizontal alignment of the tabs. .. rst-class:: classref-item-separator @@ -994,7 +994,7 @@ Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. Thi |void| **set_tab_language**\ (\ tab_idx\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` -Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Sets the language code of the title for the tab at index ``tab_idx`` to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used. .. rst-class:: classref-item-separator diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 32b1d7581..2652fd9bd 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -488,7 +488,7 @@ The focus access mode for the internal :ref:`TabBar` node. - |void| **set_tabs_position**\ (\ value\: :ref:`TabPosition`\ ) - :ref:`TabPosition` **get_tabs_position**\ (\ ) -The position of the tab bar. +The horizontal alignment of the tabs. .. rst-class:: classref-item-separator diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 75b72951c..3f6e4f0ab 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -1506,7 +1506,7 @@ If ``true``, all wrapped lines are indented to the same amount as the unwrapped - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_textmesh.rst b/classes/class_textmesh.rst index 2b02facb6..7287bd629 100644 --- a/classes/class_textmesh.rst +++ b/classes/class_textmesh.rst @@ -187,7 +187,7 @@ Font size of the **TextMesh**'s text. This property works in tandem with :ref:`p - |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) - :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) -Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. +Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). .. rst-class:: classref-item-separator @@ -221,7 +221,7 @@ Line fill alignment rules. - |void| **set_language**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_language**\ (\ ) -Language code used for text shaping algorithms, if left empty current locale is used instead. +Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead. .. rst-class:: classref-item-separator diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 363cfd9bd..d94eb4e57 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -1966,7 +1966,7 @@ Returns ``true`` if font texture mipmap generation is enabled. **Deprecated:** Use :ref:`Viewport` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead. -Deprecated. This method always returns ``1.0``. +This method does nothing and always returns ``1.0``. .. rst-class:: classref-item-separator @@ -2540,7 +2540,7 @@ Returns ``true`` if auto-hinting is supported and preferred over font built-in h :ref:`bool` **font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| :ref:`🔗` -Returns ``true``, if font supports given language (`ISO 639 `__ code). +Returns ``true`` if the font supports the given language (as a `ISO 639 `__ code). .. rst-class:: classref-item-separator @@ -2552,7 +2552,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |const| :ref:`🔗` -Returns ``true``, if color modulation is applied when drawing colored glyphs. +Returns ``true`` if color modulation is applied when drawing the font's colored glyphs. .. rst-class:: classref-item-separator @@ -2576,7 +2576,7 @@ Returns ``true`` if glyphs of all sizes are rendered using single multichannel s :ref:`bool` **font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| :ref:`🔗` -Returns ``true``, if font supports given script (ISO 15924 code). +Returns ``true`` if the font supports the given script (as a `ISO 15924 `__ code). .. rst-class:: classref-item-separator @@ -2846,7 +2846,7 @@ If set to ``true`` font texture mipmap generation is enabled. **Deprecated:** Use :ref:`Viewport` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead. -Deprecated. This method does nothing. +This method does nothing. .. rst-class:: classref-item-separator @@ -3460,7 +3460,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). :ref:`int` **name_to_tag**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` -Converts readable feature, variation, script, or language name to OpenType tag. +Converts the given readable name of a feature, variation, script, or language to an OpenType tag. .. rst-class:: classref-item-separator @@ -4563,7 +4563,7 @@ When ``chars_per_line`` is greater than zero, line break boundaries are returned :ref:`String` **string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` -Returns the string converted to lowercase. +Returns the string converted to ``lowercase``. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` feature (supported by :ref:`TextServerAdvanced`). @@ -4579,7 +4579,7 @@ Returns the string converted to lowercase. :ref:`String` **string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` -Returns the string converted to title case. +Returns the string converted to ``Title Case``. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` feature (supported by :ref:`TextServerAdvanced`). @@ -4595,7 +4595,7 @@ Returns the string converted to title case. :ref:`String` **string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| :ref:`🔗` -Returns the string converted to uppercase. +Returns the string converted to ``UPPERCASE``. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION` feature (supported by :ref:`TextServerAdvanced`). @@ -4625,7 +4625,7 @@ Strips diacritics from the string. :ref:`String` **tag_to_name**\ (\ tag\: :ref:`int`\ ) |const| :ref:`🔗` -Converts OpenType tag to readable feature, variation, script, or language name. +Converts the given OpenType tag to the readable name of a feature, variation, script, or language. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index af3676835..b5b2f3a71 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -1370,7 +1370,7 @@ Returns ``true`` if auto-hinting is supported and preferred over font built-in h :ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Returns ``true``, if font supports given language (`ISO 639 `__ code). +Returns ``true`` if the font supports the given language (as a `ISO 639 `__ code). .. rst-class:: classref-item-separator @@ -1382,7 +1382,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **_font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` -Returns ``true``, if color modulation is applied when drawing colored glyphs. +Returns ``true`` if color modulation is applied when drawing the font's colored glyphs. .. rst-class:: classref-item-separator @@ -1406,7 +1406,7 @@ Returns ``true`` if glyphs of all sizes are rendered using single multichannel s :ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Returns ``true``, if font supports given script (ISO 15924 code). +Returns ``true`` if the font supports the given script (as a `ISO 15924 `__ code). .. rst-class:: classref-item-separator @@ -2264,7 +2264,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). :ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Converts readable feature, variation, script, or language name to OpenType tag. +Converts the given readable name of a feature, variation, script, or language to an OpenType tag. .. rst-class:: classref-item-separator @@ -3350,7 +3350,7 @@ Returns an array of the word break boundaries. Elements in the returned array ar :ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Returns the string converted to lowercase. +Returns the string converted to ``lowercase``. .. rst-class:: classref-item-separator @@ -3362,7 +3362,7 @@ Returns the string converted to lowercase. :ref:`String` **_string_to_title**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Returns the string converted to title case. +Returns the string converted to ``Title Case``. .. rst-class:: classref-item-separator @@ -3374,7 +3374,7 @@ Returns the string converted to title case. :ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` -Returns the string converted to uppercase. +Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-item-separator @@ -3398,7 +3398,7 @@ Strips diacritics from the string. :ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` -Converts OpenType tag to readable feature, variation, script, or language name. +Converts the given OpenType tag to the readable name of a feature, variation, script, or language. .. rst-class:: classref-item-separator diff --git a/classes/class_thread.rst b/classes/class_thread.rst index e1b45da8d..5feff4fca 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -21,9 +21,7 @@ Description A unit of execution in a process. Can run methods on :ref:`Object`\ s simultaneously. The use of synchronization via :ref:`Mutex` or :ref:`Semaphore` is advised if working with shared objects. -\ **Warning:**\ - -To ensure proper cleanup without crashes or deadlocks, when a **Thread**'s reference count reaches zero and it is therefore destroyed, the following conditions must be met: +\ **Warning:** To ensure proper cleanup without crashes or deadlocks, when a **Thread**'s reference count reaches zero and it is therefore destroyed, the following conditions must be met: - It must not have any :ref:`Mutex` objects locked. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 09fdbfb7b..1d14637c8 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -23,7 +23,7 @@ The **Timer** node is a countdown timer and is the simplest way to handle time-b After a timer enters the scene tree, it can be manually started with :ref:`start()`. A timer node is also started automatically if :ref:`autostart` is ``true``. -Without requiring much code, a timer node can be added and configured in the editor. The :ref:`timeout` signal it emits can also be connected through the Node dock in the editor: +Without requiring much code, a timer node can be added and configured in the editor. The :ref:`timeout` signal it emits can also be connected through the Signals dock in the editor: :: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 54db6a96b..228b9171a 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -64,39 +64,43 @@ Properties .. table:: :widths: auto - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`allow_reselect` | ``false`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`allow_search` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`auto_tooltip` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`column_titles_visible` | ``false`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`columns` | ``1`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`drop_mode_flags` | ``0`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`enable_drag_unfolding` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`enable_recursive_folding` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`hide_folding` | ``false`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`hide_root` | ``false`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_horizontal_enabled` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`scroll_vertical_enabled` | ``true`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`SelectMode` | :ref:`select_mode` | ``0`` | - +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_reselect` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`auto_tooltip` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`column_titles_visible` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`columns` | ``1`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`drop_mode_flags` | ``0`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`enable_drag_unfolding` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`enable_recursive_folding` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_folding` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hide_root` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`ScrollHintMode` | :ref:`scroll_hint_mode` | ``0`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_horizontal_enabled` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`scroll_vertical_enabled` | ``true`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`SelectMode` | :ref:`select_mode` | ``0`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tile_scroll_hint` | ``false`` | + +-------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -295,6 +299,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`indeterminate_disabled` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Texture2D` | :ref:`scroll_hint` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`select_arrow` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`unchecked` | | @@ -612,6 +618,48 @@ Enables "above item" and "below item" drop sections. The "above item" drop secti When combined with :ref:`DROP_MODE_ON_ITEM`, these drop sections halves the height and stays on top / bottom accordingly. +.. rst-class:: classref-item-separator + +---- + +.. _enum_Tree_ScrollHintMode: + +.. rst-class:: classref-enumeration + +enum **ScrollHintMode**: :ref:`🔗` + +.. _class_Tree_constant_SCROLL_HINT_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_DISABLED** = ``0`` + +Scroll hints will never be shown. + +.. _class_Tree_constant_SCROLL_HINT_MODE_BOTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_BOTH** = ``1`` + +Scroll hints will be shown at the top and bottom. + +.. _class_Tree_constant_SCROLL_HINT_MODE_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_TOP** = ``2`` + +Only the top scroll hint will be shown. + +.. _class_Tree_constant_SCROLL_HINT_MODE_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScrollHintMode` **SCROLL_HINT_MODE_BOTTOM** = ``3`` + +Only the bottom scroll hint will be shown. + .. rst-class:: classref-section-separator ---- @@ -810,6 +858,23 @@ If ``true``, the tree's root is hidden. ---- +.. _class_Tree_property_scroll_hint_mode: + +.. rst-class:: classref-property + +:ref:`ScrollHintMode` **scroll_hint_mode** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_scroll_hint_mode**\ (\ value\: :ref:`ScrollHintMode`\ ) +- :ref:`ScrollHintMode` **get_scroll_hint_mode**\ (\ ) + +The way which scroll hints (indicators that show that the content can still be scrolled in a certain direction) will be shown. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_property_scroll_horizontal_enabled: .. rst-class:: classref-property @@ -857,6 +922,23 @@ If ``true``, enables vertical scrolling. Allows single or multiple selection. See the :ref:`SelectMode` constants. +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_property_tile_scroll_hint: + +.. rst-class:: classref-property + +:ref:`bool` **tile_scroll_hint** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tile_scroll_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_hint_tiled**\ (\ ) + +If ``true``, the scroll hint texture will be tiled instead of stretched. See :ref:`scroll_hint_mode`. + .. rst-class:: classref-section-separator ---- @@ -1355,7 +1437,7 @@ Sets column title base writing direction. |void| **set_column_title_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` -Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Sets the language code of the given ``column``'s title to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used. .. rst-class:: classref-item-separator @@ -1992,6 +2074,18 @@ The check icon to display when the :ref:`TreeItem.CELL_MODE_CHECK` **scroll_hint** :ref:`🔗` + +The indicator that will be shown when the content can still be scrolled. See :ref:`scroll_hint_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_icon_select_arrow: .. rst-class:: classref-themeproperty diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 199b3d8f8..8a019152e 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -1652,7 +1652,7 @@ If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. |void| **set_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) :ref:`🔗` -Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +Sets the language code of the given ``column``'s text to ``language``. This is used for line-breaking and text shaping algorithms. If ``language`` is empty, the current locale is used. .. rst-class:: classref-item-separator diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 7c29fdc60..9cc115535 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -706,7 +706,7 @@ Divides each component of the **Vector2i** by the given :ref:`float :: - print(Vector2i(10, 20) / 2.9) # Prints (5.0, 10.0) + print(Vector2i(1, 2) / 2.5) # Prints (0.4, 0.8) .. rst-class:: classref-item-separator diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index d32fc61e5..360031aca 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -730,7 +730,7 @@ Divides each component of the **Vector3i** by the given :ref:`float :: - print(Vector3i(10, 20, 30) / 2.9) # Prints (5.0, 10.0, 15.0) + print(Vector3i(1, 2, 3) / 2.5) # Prints (0.4, 0.8, 1.2) .. rst-class:: classref-item-separator diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 9c8dddf04..11b1fccbe 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -697,7 +697,7 @@ Returns a Vector4 value due to floating-point operations. :: - print(Vector4i(10, 20, 30, 40) / 2) # Prints (5.0, 10.0, 15.0, 20.0) + print(Vector4i(1, 2, 3, 4) / 2.5) # Prints (0.4, 0.8, 1.2, 1.6) .. rst-class:: classref-item-separator diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 9fa95a7e1..0510ce89a 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -1310,7 +1310,7 @@ The rendering layers in which this **Viewport** renders :ref:`CanvasItem`\ ) - :ref:`DefaultCanvasItemTextureFilter` **get_default_canvas_item_texture_filter**\ (\ ) -Sets the default filter mode used by :ref:`CanvasItem`\ s in this Viewport. +The default filter mode used by :ref:`CanvasItem` nodes in this viewport. .. rst-class:: classref-item-separator @@ -1327,7 +1327,7 @@ Sets the default filter mode used by :ref:`CanvasItem`\ s in t - |void| **set_default_canvas_item_texture_repeat**\ (\ value\: :ref:`DefaultCanvasItemTextureRepeat`\ ) - :ref:`DefaultCanvasItemTextureRepeat` **get_default_canvas_item_texture_repeat**\ (\ ) -Sets the default repeat mode used by :ref:`CanvasItem`\ s in this Viewport. +The default repeat mode used by :ref:`CanvasItem` nodes in this viewport. .. rst-class:: classref-item-separator @@ -1987,9 +1987,7 @@ See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`\ ) - :ref:`bool` **is_using_hdr_2d**\ (\ ) -If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility renderer, this will be an ``RGBA16`` framebuffer. When using the Mobile renderer, it will be an ``RGB10_A2`` framebuffer. - -Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen). +If ``true``, 2D rendering will use a high dynamic range (HDR) ``RGBA16`` format framebuffer. Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color encoding adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. @@ -2439,7 +2437,7 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro :ref:`String` **gui_get_drag_description**\ (\ ) |const| :ref:`🔗` -Returns the drag data human-readable description. +Returns the human-readable description of the drag data, used for assistive apps. .. rst-class:: classref-item-separator @@ -2515,7 +2513,7 @@ Removes the focus from the currently focused :ref:`Control` withi |void| **gui_set_drag_description**\ (\ description\: :ref:`String`\ ) :ref:`🔗` -Sets the drag data human-readable description. +Sets the human-readable description of the drag data to ``description``, used for assistive apps. .. rst-class:: classref-item-separator diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index b2a1603c2..d7bd6d92b 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -179,9 +179,9 @@ The :ref:`VoxelGIData` resource that holds the data for this - |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_size**\ (\ ) -The size of the area covered by the **VoxelGI**. If you make the size larger without increasing the subdivisions with :ref:`subdiv`, the size of each cell will increase and result in lower detailed lighting. +The size of the area covered by the **VoxelGI**. This must be ``1.0`` or greater on each axis. -\ **Note:** Size is clamped to 1.0 unit or more on each axis. +\ **Note:** If you make the size larger without increasing the number of subdivisions with :ref:`subdiv`, the size of each cell will increase and result in less detailed lighting. .. rst-class:: classref-item-separator diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index cce24e4f6..77495bbfa 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -21,17 +21,26 @@ Interface to a WebRTC peer connection. Description ----------- -A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain and monitor the connection. +A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain, and monitor the connection. Setting up a WebRTC connection between two peers may not seem a trivial task, but it can be broken down into 3 main steps: -- The peer that wants to initiate the connection (``A`` from now on) creates an offer and send it to the other peer (``B`` from now on). +- The peer that wants to initiate the connection (``A`` from now on) creates an offer and sends it to the other peer (``B`` from now on). -- ``B`` receives the offer, generate and answer, and sends it to ``A``). +- ``B`` receives the offer, generates an answer, and sends it to ``A``. -- ``A`` and ``B`` then generates and exchange ICE candidates with each other. +- ``A`` and ``B`` then generate and exchange ICE candidates with each other. -After these steps, the connection should become connected. Keep on reading or look into the tutorial for more information. +After these steps, the connection should be established. Refer to the linked tutorials for details. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`WebRTC documentation <../tutorials/networking/webrtc>` + +- :doc:`High-level multiplayer <../tutorials/networking/high_level_multiplayer>` .. rst-class:: classref-reftable-group diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 20a23b57a..c4f159274 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -19,7 +19,7 @@ A WebSocket connection. Description ----------- -This class represents WebSocket connection, and can be used as a WebSocket client (RFC 6455-compliant) or as a remote peer of a WebSocket server. +This class represents WebSocket connection, and can be used as a WebSocket client (`RFC 6455 `__-compliant) or as a remote peer of a WebSocket server. You can send WebSocket binary frames using :ref:`PacketPeer.put_packet()`, and WebSocket text frames using :ref:`send()` (prefer text frames when interacting with text-based API). You can check the frame type of the last packet via :ref:`was_string_packet()`. @@ -337,9 +337,13 @@ Accepts a peer connection performing the HTTP handshake as a WebSocket server. T |void| **close**\ (\ code\: :ref:`int` = 1000, reason\: :ref:`String` = ""\ ) :ref:`🔗` -Closes this WebSocket connection. ``code`` is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). ``reason`` is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). If ``code`` is negative, the connection will be closed immediately without notifying the remote peer. +Closes this WebSocket connection. -\ **Note:** To achieve a clean close, you will need to keep polling until :ref:`STATE_CLOSED` is reached. +\ ``code`` is the status code for the closure (see `RFC 6455 section 7.4 `__ for a list of valid status codes). If ``code`` is negative, the connection will be closed immediately without notifying the remote peer. + +\ ``reason`` is the human-readable reason for closing the connection. It can be any UTF-8 string that's smaller than 123 bytes. + +\ **Note:** To achieve a clean closure, you will need to keep polling until :ref:`STATE_CLOSED` is reached. \ **Note:** The Web export might not support all status codes. Please refer to browser-specific documentation for more details. diff --git a/classes/class_window.rst b/classes/class_window.rst index 13ee971a4..0cdb418d6 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -2403,7 +2403,7 @@ Returns ``true`` if font oversampling is enabled. See :ref:`set_use_font_oversam |void| **move_to_center**\ (\ ) :ref:`🔗` -Centers a native window on the current screen and an embedded window on its embedder :ref:`Viewport`. +Centers the window in the current screen. If the window is embedded, it is centered in the embedder :ref:`Viewport` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index ba5a72491..cc01e79d4 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -307,7 +307,7 @@ Returns a :ref:`Dictionary` with system information related to :ref:`TrackingStatus` **_get_tracking_status**\ (\ ) |virtual| |const| :ref:`🔗` -Returns an :ref:`TrackingStatus` specifying the current status of our tracking. +Returns the current status of our tracking. .. rst-class:: classref-item-separator diff --git a/classes/index.rst b/classes/index.rst index 0c2d5d639..3bd79d2da 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -50,6 +50,7 @@ Nodes class_bone2d class_boneattachment3d class_boneconstraint3d + class_bonetwistdisperser3d class_boxcontainer class_button class_camera2d